Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update DG & PR template to improve release process #2361

Merged
merged 2 commits into from
Sep 9, 2023
Merged

Update DG & PR template to improve release process #2361

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8084f9a
update docs
tlylt Aug 27, 2023
179eed1
fix formatting
tlylt Aug 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,3 +56,22 @@
We'll try our best to get to your PR within a week.
If we haven't gotten to it then, or if your pull request resolves an urgent item, feel free to give us a ping!
-->

---

**Reviewer checklist:**

Indicate the [SEMVER](https://semver.org/) impact of the PR:
- [ ] Major (when you make incompatible API changes)
- [ ] Minor (when you add functionality in a backward compatible manner)
- [ ] Patch (when you make backward compatible bug fixes)

At the end of the review, please label the PR with the appropriate label: `r.Major`, `r.Minor`, `r.Patch`.

Breaking change release note preparation (if applicable):
- To be included in the release note for any feature that is made obsolete/breaking

> Give a brief explanation note about:
> - what was the old feature that was made obsolete
> - any replacement feature (if any), and
> - how the author should modify his website to migrate from the old feature to the replacement feature (if possible).
15 changes: 15 additions & 0 deletions docs/devGuide/projectManagement.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,20 @@ For general best practices, refer to the guide [_Working with PRs_ @SE-EDU](http

* Before confirming the merge, do ensure that no other PRs have been merged to master _since the time you started drafting the merging commit's title and message_. Otherwise, you may face a glitch where GitHub merges your PR without squashing. (Reference: [MarkBind#1160](https://github.com/MarkBind/markbind/pull/1160))

1. **Use the r.Major/Minor/Patch label** to tag the PR.

<box type="info" seamless>

**Reason:** The release manager may not review all PRs, so please add the label to highlight the version impact of the PR. This helps to clarify which milestone the PR should be assigned to.
</box>

1. **Draft the release note for breaking changes**.

<box type="info" seamless>

**Reason:** The release manager may not have the full details of the PR, so please work with the PR author to prepare a release note (if applicable) in the PR description.
</box>

1. **Set a milestone** to the PR.

<box type="info" seamless>
Expand Down Expand Up @@ -102,6 +116,7 @@ For general best practices, refer to the guide [_Working with PRs_ @SE-EDU](http

<box type="info" seamless>

* Double check that the PRs are correctly set to the milestone for the new version. Review the definition of [SEMVER](https://semver.org/) and the impact of the PRs.
* We will specify updated version numbers exactly to ensure that each version will consistently fetch the same versioned internal packages.
* The end result of this command is version commit with an appropriate tag. We will make use of the generated tag and commit message later.
* Do not push this commit to the remote repository yet.
Expand Down