Unverified Commit 32b1e464 authored by Pol Dellaiera's avatar Pol Dellaiera Committed by GitHub
Browse files

Merge pull request #238126 from nikstur/contributing-release-notes 

CONTRIBUTING.md: remove historical trivia
parents f1907885 9a1f50a5

.github/PULL_REQUEST_TEMPLATE.md

+1 −1
Original line number Diff line number Diff line
@@ -22,7 +22,7 @@ For new packages please briefly describe the package or provide a link to its ho 
  - made sure NixOS tests are [linked](https://nixos.org/manual/nixpkgs/unstable/#ssec-nixos-tests-linking) to the relevant packages

- [ ] Tested compilation of all packages that depend on this change using `nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD"`. Note: all changes have to be committed, also see [nixpkgs-review usage](https://github.com/Mic92/nixpkgs-review#usage)

- [ ] Tested basic functionality of all binary files (usually in `./result/bin/`)

- [23.11 Release Notes (or backporting 23.05 Release notes)](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md#generating-2305-release-notes)

- [23.11 Release Notes](https://github.com/NixOS/nixpkgs/blob/master/nixos/doc/manual/release-notes/rl-2311.section.md) (or backporting [23.05 Release notes](https://github.com/NixOS/nixpkgs/blob/master/nixos/doc/manual/release-notes/rl-2305.section.md))

  - [ ] (Package updates) Added a release notes entry if the change is major or breaking

  - [ ] (Module updates) Added a release notes entry if the change is significant

  - [ ] (Module addition) Added a release notes entry if adding a new NixOS module

CONTRIBUTING.md

+0 −13
Original line number Diff line number Diff line
@@ -161,19 +161,6 @@ Anything that does not cause user or downstream dependency regressions can be ba 
- Services which require a client to be up-to-date regardless. (E.g. `spotify`, `steam`, or `discord`)

- Security critical applications (E.g. `firefox`)



## Generating 23.11 Release Notes

<!--

note: title unchanged even though we don't need regeneration because extant

PRs will link here. definitely change the title for 23.11 though.

-->



Documentation in nixpkgs is transitioning to a markdown-centric workflow. In the past release notes required a translation step to convert from markdown to a compatible docbook document, but this is no longer necessary.



Steps for updating 23.11 Release notes:



1. Edit `nixos/doc/manual/release-notes/rl-2311.section.md` with the desired changes

2. Commit changes to `rl-2311.section.md`.



## Reviewing contributions



See the nixpkgs manual for more details on how to [Review contributions](https://nixos.org/nixpkgs/manual/#chap-reviewing-contributions).