contributing: Add section about release versions and deprecation

Picked up from a stale PR and corrected to state TBD.

Co-authored-by: Steven Roose @stevenroose
This commit is contained in:
Steven Roose 2023-10-22 20:28:06 +01:00 committed by Jamil Lambert, PhD
parent 88af71c81f
commit 10148adc31
No known key found for this signature in database
GPG Key ID: 54DC29234AB5D2C0
1 changed files with 12 additions and 0 deletions

View File

@ -125,6 +125,18 @@ adhere to the ideas presented in the following two blog posts:
- [How to Write a Git Commit Message](https://cbea.ms/git-commit/)
- [Write Better Commits, Build Better Projects](https://github.blog/2022-06-30-write-better-commits-build-better-projects/)
### Deprecation and Versioning
Whenever any part of your code wants to mention the version number the code will
be released in, primarily in deprecation notices, you should use the string
`TBD` (verbatim), so that the release preparation script can detect the
change and the correct version number can be filled in in preparation of the
release.
```rust
#[deprecated(since = "TBD", note = "use `alternative_method()` instead")]
```
### Peer review
Anyone may participate in peer review which is expressed by comments in the pull