cafkafk/nixpkgs
cafkafk/nixpkgs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 2
nixpkgs/doc/contributing/submitting-changes.chapter.md

89 lines
4.1 KiB
Markdown
Raw Normal View History

doc: convert Submitting changes to Markdown
2020-12-05 12:38:09 +01:00
# Submitting changes {#chap-submitting-changes}
doc/submitting-changes: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided.
2023-07-25 18:29:04 +02:00
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
doc: convert Submitting changes to Markdown
2020-12-05 12:38:09 +01:00
## Submitting changes {#submitting-changes-submitting-changes}
doc/submitting-changes: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided.
2023-07-25 18:29:04 +02:00
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
doc: convert Submitting changes to Markdown
2020-12-05 12:38:09 +01:00
## Submitting security fixes {#submitting-changes-submitting-security-fixes}
doc/submitting-changes: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided.
2023-07-25 18:29:04 +02:00
This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md).
doc: convert Submitting changes to Markdown
2020-12-05 12:38:09 +01:00
doc: add instructions to remove a package Co-authored-by: Sandro <sandro.jaeckel@gmail.com> Co-authored-by: Ben Siraphob <bensiraphob@gmail.com>
2021-03-15 22:47:40 +01:00
## Deprecating/removing packages {#submitting-changes-deprecating-packages}
doc/submitting-changes: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided.
2023-07-25 18:29:04 +02:00
This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md).
doc: add instructions to remove a package Co-authored-by: Sandro <sandro.jaeckel@gmail.com> Co-authored-by: Ben Siraphob <bensiraphob@gmail.com>
2021-03-15 22:47:40 +01:00
doc: prepare for commonmark We are still using Pandoc’s Markdown parser, which differs from CommonMark spec slightly. Notably: - Line breaks in lists behave differently. - Admonitions do not support the simpler syntax https://github.com/jgm/commonmark-hs/issues/75 - The auto_identifiers uses a different algorithm – I made the previous ones explicit. - Languages (classes) of code blocks cannot contain whitespace so we have to use “pycon” alias instead of Python “console” as GitHub’s linguist While at it, I also fixed the following issues: - ShellSesssion was used - Removed some pointless docbook tags.
2021-06-05 21:22:45 +02:00
### Steps to remove a package from Nixpkgs {#steps-to-remove-a-package-from-nixpkgs}
doc: add instructions to remove a package Co-authored-by: Sandro <sandro.jaeckel@gmail.com> Co-authored-by: Ben Siraphob <bensiraphob@gmail.com>
2021-03-15 22:47:40 +01:00
doc/submitting-changes: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided.
2023-07-25 18:29:04 +02:00
This section has been moved to [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md).
doc: add instructions to remove a package Co-authored-by: Sandro <sandro.jaeckel@gmail.com> Co-authored-by: Ben Siraphob <bensiraphob@gmail.com>
2021-03-15 22:47:40 +01:00
doc: convert Submitting changes to Markdown
2020-12-05 12:38:09 +01:00
## Pull Request Template {#submitting-changes-pull-request-template}
doc/submitting-changes: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided.
2023-07-25 18:29:04 +02:00
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
doc: convert Submitting changes to Markdown
2020-12-05 12:38:09 +01:00
### Tested using sandboxing {#submitting-changes-tested-with-sandbox}
doc/submitting-changes: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided.
2023-07-25 18:29:04 +02:00
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
doc: convert Submitting changes to Markdown
2020-12-05 12:38:09 +01:00
### Built on platform(s) {#submitting-changes-platform-diversity}
doc/submitting-changes: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided.
2023-07-25 18:29:04 +02:00
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
doc: convert Submitting changes to Markdown
2020-12-05 12:38:09 +01:00
### Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests) {#submitting-changes-nixos-tests}
doc/submitting-changes: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided.
2023-07-25 18:29:04 +02:00
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
doc: convert Submitting changes to Markdown
2020-12-05 12:38:09 +01:00
### Tested compilation of all pkgs that depend on this change using `nixpkgs-review` {#submitting-changes-tested-compilation}
doc/submitting-changes: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided.
2023-07-25 18:29:04 +02:00
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
doc: convert Submitting changes to Markdown
2020-12-05 12:38:09 +01:00
### Tested execution of all binary files (usually in `./result/bin/`) {#submitting-changes-tested-execution}
doc/submitting-changes: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided.
2023-07-25 18:29:04 +02:00
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
doc: convert Submitting changes to Markdown
2020-12-05 12:38:09 +01:00
### Meets Nixpkgs contribution standards {#submitting-changes-contribution-standards}
doc/submitting-changes: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided.
2023-07-25 18:29:04 +02:00
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
doc: convert Submitting changes to Markdown
2020-12-05 12:38:09 +01:00
## Hotfixing pull requests {#submitting-changes-hotfixing-pull-requests}
doc/submitting-changes: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided.
2023-07-25 18:29:04 +02:00
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
doc: convert Submitting changes to Markdown
2020-12-05 12:38:09 +01:00
## Commit policy {#submitting-changes-commit-policy}
doc/submitting-changes: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided.
2023-07-25 18:29:04 +02:00
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
doc: convert Submitting changes to Markdown
2020-12-05 12:38:09 +01:00
Revert "Revert "submitting-changes.chapter.md: explain *why* we have three branches"" This reverts commit 7e6c518ce4f316cba803a40c19160606a8bfab9f. I misinterpreted Github's CI failure in the notification tab and thought that I had broken CI on origin/master, so I panic-reverted before I merged it (I thought they had). On closer inspection, it appears that the CI failure was not from the tip that I merged. This PR resubmits the reverted change. I'll wait for OfBorg to finish this time.
2023-07-12 21:59:46 +02:00
### Branches {#submitting-changes-branches}
doc/submitting-changes: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided.
2023-07-25 18:29:04 +02:00
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
docs: clarify staging Specify that the merges from master to staging-next to staging are performed by GitHub actions. This helps the reader understand the relationship between the branches.
2021-02-17 03:10:44 +01:00
Revert "Revert "submitting-changes.chapter.md: explain *why* we have three branches"" This reverts commit 7e6c518ce4f316cba803a40c19160606a8bfab9f. I misinterpreted Github's CI failure in the notification tab and thought that I had broken CI on origin/master, so I panic-reverted before I merged it (I thought they had). On closer inspection, it appears that the CI failure was not from the tip that I merged. This PR resubmits the reverted change. I'll wait for OfBorg to finish this time.
2023-07-12 21:59:46 +02:00
#### Master branch {#submitting-changes-master-branch}
doc: convert Submitting changes to Markdown
2020-12-05 12:38:09 +01:00
doc/submitting-changes: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided.
2023-07-25 18:29:04 +02:00
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
doc: convert Submitting changes to Markdown
2020-12-05 12:38:09 +01:00
Revert "Revert "submitting-changes.chapter.md: explain *why* we have three branches"" This reverts commit 7e6c518ce4f316cba803a40c19160606a8bfab9f. I misinterpreted Github's CI failure in the notification tab and thought that I had broken CI on origin/master, so I panic-reverted before I merged it (I thought they had). On closer inspection, it appears that the CI failure was not from the tip that I merged. This PR resubmits the reverted change. I'll wait for OfBorg to finish this time.
2023-07-12 21:59:46 +02:00
#### Staging branch {#submitting-changes-staging-branch}
doc: convert Submitting changes to Markdown
2020-12-05 12:38:09 +01:00
doc/submitting-changes: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided.
2023-07-25 18:29:04 +02:00
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
doc: Document that the staging branches may be restricted
2022-05-18 17:37:48 +02:00
Revert "Revert "submitting-changes.chapter.md: explain *why* we have three branches"" This reverts commit 7e6c518ce4f316cba803a40c19160606a8bfab9f. I misinterpreted Github's CI failure in the notification tab and thought that I had broken CI on origin/master, so I panic-reverted before I merged it (I thought they had). On closer inspection, it appears that the CI failure was not from the tip that I merged. This PR resubmits the reverted change. I'll wait for OfBorg to finish this time.
2023-07-12 21:59:46 +02:00
#### Staging-next branch {#submitting-changes-staging-next-branch}
doc: convert Submitting changes to Markdown
2020-12-05 12:38:09 +01:00
doc/submitting-changes: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided.
2023-07-25 18:29:04 +02:00
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
doc: Document that the staging branches may be restricted
2022-05-18 17:37:48 +02:00
Revert "Revert "submitting-changes.chapter.md: explain *why* we have three branches"" This reverts commit 7e6c518ce4f316cba803a40c19160606a8bfab9f. I misinterpreted Github's CI failure in the notification tab and thought that I had broken CI on origin/master, so I panic-reverted before I merged it (I thought they had). On closer inspection, it appears that the CI failure was not from the tip that I merged. This PR resubmits the reverted change. I'll wait for OfBorg to finish this time.
2023-07-12 21:59:46 +02:00
#### Stable release branches {#submitting-changes-stable-release-branches}
doc: convert Submitting changes to Markdown
2020-12-05 12:38:09 +01:00
doc/submitting-changes: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided.
2023-07-25 18:29:04 +02:00
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
docs: improve section `Stable release branches` - Explain branch naming scheme for stable release branches - Split into subsections `Automatically backporting ...` and `Manually backporting...`.
2021-12-09 16:02:39 +01:00
#### Automatically backporting a Pull Request {#submitting-changes-stable-release-branches-automatic-backports}
doc/submitting-changes: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided.
2023-07-25 18:29:04 +02:00
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
docs: improve section `Stable release branches` - Explain branch naming scheme for stable release branches - Split into subsections `Automatically backporting ...` and `Manually backporting...`.
2021-12-09 16:02:39 +01:00
#### Manually backporting changes {#submitting-changes-stable-release-branches-manual-backports}
doc/submitting-changes: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided.
2023-07-25 18:29:04 +02:00
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
doc/manual: Add backport criteria
2021-06-04 18:13:28 +02:00
doc: assign ids to many headings without stable ids on headings we cannot generate stable links to these headings. nrd complains about this, but the current docbook workflow does not. a few generated ids remain, mostly in examples and footnotes. most of the examples are generated by nixdoc (which has since gained MD export functions, and the MD export does generate IDs).
2023-03-27 22:39:11 +02:00
#### Acceptable backport criteria {#acceptable-backport-criteria}
doc/manual: Add backport criteria
2021-06-04 18:13:28 +02:00
doc/submitting-changes: Rough move to new contribution doc files No content was changed, new titles are wrapped with () to signal that they will need to be decided on in a future commit. Section in the manual have been preserved with a simple redirect to GitHub, the proper anchors should be filled out in a future commit once the new section names are decided.
2023-07-25 18:29:04 +02:00
This section has been moved to [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
doc/manual: Add backport criteria
2021-06-04 18:13:28 +02:00
Reference in a new issue Copy permalink