diff --git a/README.md b/README.md index f9b535b..1d394a5 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,22 @@ patterns and conventions used in Go code at MongoDB. See [MongoDB Go Style Guide](style.md) for the style guide. +## MongoDB-Specific Changes + +This is a fork of [Uber's Go Style Guide](https://github.com/uber-go/guide/). + +At MongoDB, we aim to keep this guide as close to the upstream guide maintained by Uber as +possible. However, there will inevitable by some points of divergence over time as we develop our +own coding standards. + +When you make a change specific to this MongoDB fork, always update the +[`CHANGELOG-MongoDB.md`](./CHANGELOG-MongoDB.md) file with a summary of what you changed. This makes +it easier to reconcile differences between the Uber and MongoDB versions of this style guide. + +In addition, wherever this is practical, we should add HTML comments explaining the changes we +make. This will make it easy to keep our fork up to date with Uber's in the future, as well as make +it clear why we diverge from their recommendations. +