nora
/
rn2903
1
0
Fork 0
Code Issues Pull Requests Releases Activity

Formalize release process

This commit is contained in:
Leonora Tindall 2019-12-29 12:47:18 -08:00
parent 84fa9e5e01
commit dd2102d973
Signed by: nora
GPG Key ID: 7A8B52EC67E09AAF
2 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CHANGELOG.md
View File

@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## Unreleased - 0.2.0 ## Unreleased - v0.2.0
### Added ### Added
@ -19,7 +19,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Security ### Security
## 0.1.0 ## v0.1.0
### Added ### Added
- GNU GPL v3 license - GNU GPL v3 license

10
CONTRIBUTING.md
View File

@ -17,3 +17,13 @@ CHANGELOG.md.
All method documentation is written in the present tense. For example, "Creates a new..." All method documentation is written in the present tense. For example, "Creates a new..."
rather than "Create a new...". rather than "Create a new...".
## Cutting a Release
When cutting a release:
- In CHANGELOG, rename the Unreleased section and add a new Unreleased section above it
- Make a commit with only that change
- Tag that commit like "v1.0.0"
- Push main and the tag
- `cargo publish`