Skip to content

Document how changelog maintenance works#4579

Merged
fingolfin merged 22 commits intomasterfrom
mh/docs-changelog
Feb 28, 2025
Merged

Document how changelog maintenance works#4579
fingolfin merged 22 commits intomasterfrom
mh/docs-changelog

Conversation

@fingolfin
Copy link
Copy Markdown
Member

@fingolfin fingolfin commented Feb 12, 2025

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]

@fingolfin fingolfin added documentation Improvements or additions to documentation release notes: not needed PRs introducing changes that are wholly irrelevant to the release notes labels Feb 12, 2025
@fingolfin fingolfin marked this pull request as draft February 12, 2025 13:46
@fingolfin fingolfin added this to the 1.3.0 milestone Feb 20, 2025
@lgoettgens lgoettgens added the backport 1.3.x backport for release branch 1.3 label Feb 25, 2025
@aaruni96 aaruni96 mentioned this pull request Feb 27, 2025
11 tasks
Comment thread docs/src/DeveloperDocumentation/changelog.md Outdated
Comment thread docs/src/DeveloperDocumentation/changelog.md Outdated
Comment thread docs/src/DeveloperDocumentation/changelog.md Outdated
Comment thread docs/src/DeveloperDocumentation/changelog.md Outdated
Comment thread docs/src/DeveloperDocumentation/changelog.md Outdated
Comment thread docs/src/DeveloperDocumentation/changelog.md Outdated
Comment thread docs/src/DeveloperDocumentation/release.md Outdated
Comment thread dev/releases/release_notes.py Outdated
@fingolfin fingolfin marked this pull request as ready for review February 27, 2025 20:24
Comment on lines +61 to +77
## 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.
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@thofma
Copy link
Copy Markdown
Collaborator

thofma commented Feb 27, 2025

Are the labels set in stone? I have the half-serious suggestion of changing label: LieTheory to label: Lie theory.

@lgoettgens
Copy link
Copy Markdown
Member

Are the labels set in stone? I have the half-serious suggestion of changing label: LieTheory to label: Lie theory.

Probably easier right now than later. I agree with your suggestion, but would leave the implementation details to @fingolfin

@thofma
Copy link
Copy Markdown
Collaborator

thofma commented Feb 27, 2025

other things that could be consolidated:

topic: schemes
topic: toric schemes
topic: toric varieties
topic: algebraic geometry

Probably

topic: algebraic geometry

would be enough?

Copy link
Copy Markdown
Contributor

@BD-00 BD-00 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Found some typos.

Comment thread docs/src/DeveloperDocumentation/changelog.md Outdated
Comment thread docs/src/DeveloperDocumentation/changelog.md Outdated
Comment thread docs/src/DeveloperDocumentation/changelog.md Outdated
Comment thread docs/src/DeveloperDocumentation/changelog.md Outdated
Comment thread docs/src/DeveloperDocumentation/changelog.md Outdated
Comment thread docs/src/DeveloperDocumentation/changelog.md Outdated
Comment thread docs/src/DeveloperDocumentation/changelog.md Outdated
Comment thread docs/src/DeveloperDocumentation/release.md Outdated
Comment thread docs/src/DeveloperDocumentation/changelog.md Outdated
Comment thread docs/src/DeveloperDocumentation/changelog.md Outdated
Comment thread docs/src/DeveloperDocumentation/changelog.md Outdated
fingolfin and others added 4 commits February 28, 2025 00:05
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>
@fingolfin
Copy link
Copy Markdown
Member Author

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...)

@afkafkafk13
Copy link
Copy Markdown
Collaborator

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:
The toric and the non-toric algebraic geometry do not share the same algorithmic perspective, so I would hesitate to put everything into a single label. But I agree that 4 labels for this area is by far too many on the long run. My suggestion would be "toric geometry" and "algebraic geometry" -- this would leave us with 4 geometry labels (algebraic, polyhedral, toric and tropical). The topic "schemes" should become obsolete, as the core functionality of the schemes framework has reached a rather mature state and new development on schemes can now be covered under label of "algebraic geometry" without obstructing the view to other developments under this label.

@simonbrandhorst
Copy link
Copy Markdown
Collaborator

deleting the schemes and toric schemes topics is fine with me.

@lgoettgens lgoettgens enabled auto-merge (squash) February 28, 2025 12:06
@lgoettgens lgoettgens disabled auto-merge February 28, 2025 12:07
@fingolfin fingolfin merged commit 744bca2 into master Feb 28, 2025
@fingolfin fingolfin deleted the mh/docs-changelog branch February 28, 2025 14:48
aaruni96 added a commit that referenced this pull request Feb 28, 2025
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>
aaruni96 added a commit that referenced this pull request Feb 28, 2025
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
@aaruni96 aaruni96 removed the backport 1.3.x backport for release branch 1.3 label Mar 7, 2025
fieker pushed a commit that referenced this pull request Mar 17, 2025
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation release notes: not needed PRs introducing changes that are wholly irrelevant to the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants