Extend Release Editor section with future plans
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
I just brainstormed the idea with others.
Regarding a style guide the following needs to be considered:
- Defining rules
- Enable sorting (e.g. with the section for New Services)
- Decide how the free form sections such as Backward Incompatibilities shall look like
Regarding a do be developed linter the following needs to be considered:
- Check what linters already exist, especially in nixpkgs
- Decide what exactly shall be linted, (doubtless the markdown draft)
- Decide for a programming language to use, probably python since I know it best
- Where to package, in user repo (for the start), nix-community or nixpkgs (i.e. manual section) then
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!