Document how changelog maintenance works#4579
Conversation
2a4170b to
bbc5f6a
Compare
a519a92 to
3055d10
Compare
it makes editing and reviewing them more annoying
| ## How to set labels when submitting or reviewing a PR | ||
|
|
||
| Everyone submitting a PR should ideally follow this checklist if they also have the access | ||
| rights for assigning labels. If they don't, they should ideally leave instructions that | ||
| indicate which labels to set, and a PR reviewer should then perform the following steps. | ||
|
|
||
| 1. If your PR should *not* appear in the changelog, assign the `release notes: not needed` label and stop here. | ||
| 2. If possible, edit the title of your PR to be usable as an entry in the changelog, and assign the `release notes: use title` label. | ||
| - Hint: Try to start the title with a verb in present tense such as "Add", "Enhance", "Remove". | ||
| - Hint: if function or type names appear in the title, surround them by backticks. | ||
| 3. If you need a longer description than fits into the title, leave a comment with your suggestion | ||
| for this description, and assign the `release notes: to be added` label. | ||
| 4. In either case, also assign at least one `topic: XYZ` label, and possible some of the other | ||
| labels describe in the previous section as you deem fit. | ||
|
|
||
| Optionally, if you think your change is exceptionally noteworthy, also assign the | ||
| `release notes: highlight` label. |
There was a problem hiding this comment.
In practice I think this is the most critical section for our PR submitters (at least those who can set labels) and reviewers. So please everyone read and check this bit most carefully.
|
Are the labels set in stone? I have the half-serious suggestion of changing |
Probably easier right now than later. I agree with your suggestion, but would leave the implementation details to @fingolfin |
|
other things that could be consolidated: Probably would be enough? |
Co-authored-by: Berenike Dieterle <94169337+BD-00@users.noreply.github.com>
Co-authored-by: Martin Wagner <martin.wagner.dev@gmail.com>
Co-authored-by: Berenike Dieterle <94169337+BD-00@users.noreply.github.com> Co-authored-by: Martin Wagner <martin.wagner.dev@gmail.com>
|
Thanks @BD-00 @SoongNoonien I've rename the Lie theory label as suggested (I thought about it before as well but didn't want to do it without asking @lgoettgens ;-) ). I'd be OK with merging some or all of the "toric varieties" / "toric schemes" / "schemes" / "algebraic geometry" labels, but this is something the @oscar-system/algebraic-geometry team should perhaps comment on (and also @HereAround @lkastner @paemurru and others...) |
My purely personal opinion: |
|
deleting the schemes and toric schemes topics is fine with me. |
Co-authored-by: Aaruni Kaushik <aaruni@edufor.me> Co-authored-by: Berenike Dieterle <94169337+BD-00@users.noreply.github.com> Co-authored-by: Martin Wagner <martin.wagner.dev@gmail.com> (cherry picked from commit 744bca2) Signed-off-by: Aaruni Kaushik <aaruni@edufor.me>
Backports for 1.3.0 : Add DOI of the book #4654 Add attribute for more detailed info on tunable sections #4636 Move book tests to github runners #4629 Update Nemo to 0.49 #4645 fix a NiceMonomorphism for GAP constructed in Oscar #4640 Polyhedral: fix hash for halfspace and related types #4600 Cleanup some code related to dim(I) == -inf checks #4571 Fix bug in G4-flux computation of big model #4647 Add more missing hash functions #4638 Document how changelog maintenance works #4579 Update changelog #4667
Co-authored-by: Aaruni Kaushik <aaruni@edufor.me> Co-authored-by: Berenike Dieterle <94169337+BD-00@users.noreply.github.com> Co-authored-by: Martin Wagner <martin.wagner.dev@gmail.com>
This is still very much WIP but I wanted to put it here so @aaruni96 and me can work on it together.
We can liberally borrow from https://github.com/gap-system/gap/blob/master/dev/releases/README.release_notes.md if we want to.
[skip ci]