NixOS / release-wiki

https://nixos.github.io/release-wiki
Creative Commons Zero v1.0 Universal
21 stars 22 forks source link

Extend Release Editor section with future plans #68

Open riotbib opened 1 year ago

riotbib commented 1 year ago

Two measures by the Release Editor of 23.05 shall improve the process for creating release notes: Creating a style guide and developing a linter.

Feedback and input for both future plans are needed and wanted. The style guide shall be a generic description with best practice examples and the linter shall implement this style with pointing out faulty sections.

Please do comment on your ideas, wishes and critique to the current and future state of the release notes. Thanks

riotbib commented 1 year ago

I just brainstormed the idea with others.

Regarding a style guide the following needs to be considered:

Regarding a do be developed linter the following needs to be considered:

In the end a linter for the NixOS Release Notes shall be supporting not blocking the release process, and provide comprehensive error messages.

Any feedback still appreciated, thanks!