aboutsummaryrefslogtreecommitdiffstats
path: root/.github
diff options
context:
space:
mode:
authorLibravatar Titus Wormer <tituswormer@gmail.com>2023-01-31 11:41:16 +0100
committerLibravatar Titus Wormer <tituswormer@gmail.com>2023-01-31 11:41:16 +0100
commitb45add64fe837e01d759a9d1fcb93858f55aa85b (patch)
tree5f64f7cea4761422defc6c695e4c954baa540841 /.github
parentea219765e4c7a7b7071bb6b529e5a383898dd2d5 (diff)
downloadmarkdown-rs-b45add64fe837e01d759a9d1fcb93858f55aa85b.tar.gz
markdown-rs-b45add64fe837e01d759a9d1fcb93858f55aa85b.tar.bz2
markdown-rs-b45add64fe837e01d759a9d1fcb93858f55aa85b.zip
Add release guidelines
Diffstat (limited to '.github')
-rw-r--r--.github/contribute.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/.github/contribute.md b/.github/contribute.md
index 3a59ba4..b349b97 100644
--- a/.github/contribute.md
+++ b/.github/contribute.md
@@ -59,6 +59,18 @@ See [Project][] for more info.
* write a convincing description of why your pull request should land:
it’s your job to be convincing
+## Project (for maintainers)
+
+See [Project][project] in the readme for info on how the project is structured
+and how to run useful scripts.
+
+### Release
+
+* update the `version` field in `Cargo.toml`
+* search for the previous version in `readme.md`, replace with new one
+* `git commit --all --message 1.2.3 && git tag 1.2.3 && git push && git push --tags`
+* `cargo publish`
+
## Resources
* [how to contribute to open source](https://opensource.guide/how-to-contribute/)