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.

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

Maintain Release Notes #246

Open
cburstedde opened this issue Oct 9, 2023 · 2 comments
Open

Maintain Release Notes #246

cburstedde opened this issue Oct 9, 2023 · 2 comments

Comments

@cburstedde
Copy link
Owner

Maintain a current and complete Relase Notes file

There is a doc/release_notes.txt file in libsc, which I would encourage everyone to update synchronously to their proposed changes to the code. For p4est, I've just added a mostly empty version to the develop branch.

It will be helpful to our collaborators and users to add to this file with every PR or other addition to the code.

@sloede
Copy link
Contributor

sloede commented Oct 9, 2023

Hi Carsten, I think this is a great addition! And will certainly make our (downstream maintainer) lives a little easier!

One suggestion, if I may: if you make it a markdown file instead of a plain text file, it is a little nicer to view on GitHub and might also encourage people to include, eg, links to relevant PRs. But a plain text file is also OK, of course.

@cburstedde
Copy link
Owner Author

We've tried the latest release 2.8.6 (out now!) as is and may look into markdown in the future. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants