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

Add documentation to make life for package maintainers easier #5749

Merged
merged 3 commits into from Feb 15, 2024

Conversation

impaktor
Copy link
Member

@impaktor impaktor commented Feb 7, 2024

This saves our release announcements to a new NEWS.md file. Alternative PR title could have been: appease @laarmen

Note to @Gliese852 @Web-eWorks @laarmen

  • Please check the new section in COMPILING file that I've copy-pasted from latest release announcement if this is correct & good?
  • Please note the first paragraph in NEWS.md specifying what the file is about, also a nod towards package maintainers.

If this is merged, we/I should also update the https://dev.pioneerspacesim.net/contribute/making-a-release page with how to deal with the new file after release.

- Add NEWS.md file, copy of all github release announcements
- Add information to COMPILING pertinent to package maintainers
- Add NEWS to release in CMakeLists.txt
- Amend Packagers section for clarity / to mention CMakeBuildPresetsCI.json
- Add non-exhaustive section covering important build flags
@Web-eWorks Web-eWorks merged commit 1773611 into pioneerspacesim:master Feb 15, 2024
5 checks passed
@impaktor impaktor deleted the documentation-update branch February 17, 2024 12:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants