From 68487d2278c46939deb986d0add126d6736ced74 Mon Sep 17 00:00:00 2001 From: Chris Carini <6374067+ChrisCarini@users.noreply.github.com> Date: Thu, 21 Oct 2021 03:15:50 -0700 Subject: [PATCH] Updating CONTRIBUTING.md to encourage auto-generated release notes. --- CONTRIBUTING.md | 30 +++++++++++++++++------------- 1 file changed, 17 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 21effd7..ef5383c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,26 +15,30 @@ For general contributions, please open an issue on GitHub using one of the below 2. **version tag:** we follow the format `v` (ie, `v1.0.1`) 3. **target:** Likely targeting the `master` branch, but possible a different commit. 4. **release title:** `Release v` (ie, `Release v1.0.1`) - 5. **description:** - ```markdown - + 5. **description:** Click the `Auto-generate release notes` - it makes life easier. +
Previously, we used the below template - ### Added + ```markdown + - 1. N/A + ### Added - ### Upgrade + 1. N/A - 1. N/A + ### Upgrade - ### Fixed + 1. N/A - 1. N/A - ``` - (**Note:** Update the `Added`, `Upgrade`, and `Fixed` sections as needed, linking to GitHub PRs/Issues when - appropriate.) + ### Fixed + + 1. N/A + ``` + (**Note:** Update the `Added`, `Upgrade`, and `Fixed` sections as needed, linking to GitHub PRs/Issues when + appropriate.) + +
4. Click `Publish Release` 5. Update the `latest` tag to the most current release: ```shell git tag -d latest && git push origin :refs/tags/latest && git tag latest master && git push origin latest - ``` \ No newline at end of file + ```