From 2c7d7e428c64381ec025f30060fe240c70f52fd8 Mon Sep 17 00:00:00 2001 From: nikstur Date: Fri, 16 Jun 2023 19:42:06 +0200 Subject: [PATCH 1/2] CONTRIBUTING.md: remove historical trivia The transition to markdown is done now and the historical trivia is not helpful for first time contributers who are the primary audience for this document. Telling the user to edit a file by editing a file is superfluous. --- CONTRIBUTING.md | 13 ------------- 1 file changed, 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1ba2ae48da4e..694cbcd1a36c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -128,19 +128,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 - - -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). From 9a1f50a5880a013bc70dd1ff99f53096e279b559 Mon Sep 17 00:00:00 2001 From: nikstur Date: Fri, 16 Jun 2023 23:51:35 +0200 Subject: [PATCH 2/2] .github/PULL_REQUEST_TEMPLATE.md: directly link to release notes --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 4fb4c0f68f9b..b2ec787313e0 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -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