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

Extend Release Editor section with future plans #68

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

riotbib
Copy link
Member

@riotbib riotbib commented Jun 14, 2023

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

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 for both is 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.
@riotbib riotbib requested a review from mweinelt June 14, 2023 21:37
@riotbib riotbib marked this pull request as draft June 14, 2023 21:37
@riotbib
Copy link
Member Author

riotbib commented Jun 21, 2023

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!

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

1 participant