Skip to content

Commit ead607b

Browse files
committed
Add section on making MongoDB-specific changes
1 parent cda0241 commit ead607b

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

+10
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,16 @@ patterns and conventions used in Go code at MongoDB.
55

66
See [MongoDB Go Style Guide](style.md) for the style guide.
77

8+
## MongoDB-Specific Changes
9+
10+
At MongoDB, we aim to keep this guide as close to the upstream guide maintained by Uber as
11+
possible. However, there will inevitable by some points of divergence over time as we develop our
12+
own coding standards.
13+
14+
When you make a change specific to this MongoDB fork, always update the
15+
[`CHANGELOG-MongoDB.md`](./CHANGELOG-MongoDB.md) file with a summary of what you changed. This makes
16+
it easier to reconcile differences between the Uber and MongoDB versions of this style guide.
17+
818
<!--
919
1020
## Translations

0 commit comments

Comments
 (0)