commit 827a022f069fd99dcd1530492098005171e7b760
parent a977b45511e5a8c80e4d46063cabf3ca96aad28b
Author: Rand McKinney <crandmck@yahoo.com>
Date: Wed, 3 Aug 2022 10:38:09 -0700
(IGNORE) Add info on PR title prefixes (IGNORE), (MINOR), and (MAJOR) to contribution guidelines. (#91)
* Update CONTRIBUTING.md
* Update CONTRIBUTING.md
* Add note about using (MINOR) flag for API breaking changes
Co-authored-by: Eric Scouten <scouten@adobe.com>
Diffstat:
1 file changed, 8 insertions(+), 0 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -59,6 +59,14 @@ These include such things as Rust code format, Clippy/lint checks, and unit test
We encourage you to raise an issue in GitHub before starting work on a major addition to the crate.
This will give us an opportunity to discuss API design and avoid duplicate efforts.
+### Pull request titles
+
+The build process automatically adds a pull request (PR) to the [CHANGELOG](CHANGELOG.md) unless the title of the PR begins with `(IGNORE)`. Start PR titles with `(IGNORE)` for minor documentation updates and other trivial fixes that you want to specifically exclude from the CHANGELOG.
+
+Additionally, the build process takes specific actions if the title of a PR begins with certain special strings:
+- `(MINOR)`: Increments the minor version, per [semantic versioning](https://semver.org/) convention. **IMPORTANT:** This flag should be used for any API change that breaks compatibility with previous releases while this crate is in prerelease (version 0.x) status.
+- `(MAJOR)`: Increments the major version number, per [semantic versioning](https://semver.org/) convention.
+
## From contributor to committer
We love contributions from our community! If you'd like to go a step beyond contributor
