|
1 | 1 | # Summary
|
| 2 | + |
2 | 3 | Contributing to the Mongodb Controllers for Kubernetes (MCK) project
|
3 |
| -Pull requests are always welcome, and the MCK dev team appreciates any help the community can give to help make MongoDB better. |
| 4 | +Pull requests are always welcome, and the MCK dev team appreciates any help the community can give to help make MongoDB |
| 5 | +better. |
| 6 | + |
| 7 | +## PR Prerequisites |
4 | 8 |
|
5 |
| -# PR Prerequisites |
6 |
| -* Please ensure you have signed our Contributor Agreement. You can find it [here](https://www.mongodb.com/legal/contributor-agreement). |
| 9 | +* Please ensure you have signed our Contributor Agreement. You can find |
| 10 | + it [here](https://www.mongodb.com/legal/contributor-agreement). |
7 | 11 | * Please ensure that all commits are signed.
|
| 12 | +* Create a changelog file that will describe the changes you made. Use the `skip-changelog` label if your changes do not |
| 13 | + require a changelog entry. |
| 14 | + |
| 15 | +## Changelog files and Release Notes |
| 16 | + |
| 17 | +Each Pull Request usually has a changelog file that describes the changes made in the PR using Markdown syntax. |
| 18 | +Changelog files are placed in the `changelog/` directory and used to generate the Release Notes for the |
| 19 | +upcoming release. Preview of the Release Notes is automatically added as comment to each Pull Request. |
| 20 | +The changelog file needs to follow the naming convention |
| 21 | +`YYYYMMDD-<change_kind>-<short-description>.md`. To create changelog file please use the |
| 22 | +`scripts/release/create_changelog.py` script. Example usage: |
| 23 | + |
| 24 | +```console |
| 25 | +python3 -m scripts.release.create_changelog --kind fix "Fix that I want to describe in the changelog" |
| 26 | +``` |
| 27 | + |
| 28 | +For more options, run the script with `--help`: |
| 29 | + |
| 30 | +```console |
| 31 | +python3 -m scripts.release.create_changelog --help |
| 32 | +usage: create_changelog.py [-h] [-c ] [-d ] [-e] -k title |
| 33 | + |
| 34 | +Utility to easily create a new changelog entry file. |
| 35 | + |
| 36 | +positional arguments: |
| 37 | + title Title for the changelog entry |
| 38 | + |
| 39 | +options: |
| 40 | + -h, --help show this help message and exit |
| 41 | + -c, --changelog-path |
| 42 | + Path to the changelog directory relative to the repository root. Default is changelog/ |
| 43 | + -d, --date Date in 'YYYY-MM-DD' format to use for the changelog entry. Default is today's date |
| 44 | + -e, --editor Open the created changelog entry in the default editor (if set, otherwise uses 'vi'). Default is True |
| 45 | + -k, --kind Kind of the changelog entry: |
| 46 | + - 'prelude' for prelude entries |
| 47 | + - 'breaking, major' for breaking change entries |
| 48 | + - 'feat, feature' for feature entries |
| 49 | + - 'fix, bugfix, hotfix, patch' for bugfix entries |
| 50 | + - everything else will be treated as other entries |
| 51 | +``` |
0 commit comments