Skip to content

Commit 243e34e

Browse files
committed
docs(contrib): refactor README to follow mdlinter
1 parent 7c46947 commit 243e34e

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

contrib/README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1-
#### Contribution Guide
1+
# Contribution Guide
22

3-
### Summary
3+
## Summary
44

55
This project follows [Semantic Versioning 2.0](https://semver.org/). In general, every release is associated with a tag and a changelog. `support/3.x` serves as the mainline branch for the project and represents the latest state of development.
66

7-
### Publishing a New SDK version
7+
## Publishing a New SDK version
8+
89
```bash
910
# fetch and rebase from upstream/support/3.x
1011
git fetch upstream support/3.x
@@ -16,7 +17,7 @@ git checkout -b release/3.<x>.<y>
1617
# run bump_version.bash with either patch, minor, or major
1718
./bump_version.bash <patch|minor|major>
1819

19-
# push changes to your remote origin
20+
# push changes to your remote origin
2021
git push origin release/3.<x>.<y>
2122

2223
# open a PR from that remote branch to support/3.x and get it reviewed
@@ -29,14 +30,14 @@ npm publish
2930
npm deprecate mongodb-stitch "The browser SDK has moved to mongodb-stitch-browser-sdk, and the Node.js SDK has moved to mongodb-stitch-server-sdk"
3031
```
3132

32-
### Patch Versions
33+
## Patch Versions
3334

3435
The work for a patch version should happen on a "support branch" (e.g. 1.2.x). The purpose of this is to be able to support a minor release while excluding changes from the mainstream (`master`) branch. If the changes in the patch are relevant to other branches, including `master`, they should be backported there. The general publishing flow can be followed using `patch` as the bump type in `bump_version`.
3536

36-
### Minor Versions
37+
## Minor Versions
3738

3839
The general publishing flow can be followed using `minor` as the bump type in `bump_version`.
3940

40-
### Major Versions
41+
## Major Versions
4142

4243
The general publishing flow can be followed using `major` as the bump type in `bump_version`. In addition to this, the release on GitHub should be edited for a more readable format of key changes and include any migration steps needed to go from the last major version to this one.

0 commit comments

Comments
 (0)