Skip to content

doc/manual,CONTRIBUTING.md: add treewide change syntax #148996

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.

Sign up for GitHub

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

Closed
ckiee wants to merge 2 commits into from
Closed

doc/manual,CONTRIBUTING.md: add treewide change syntax #148996

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d1ce8ba
CONTRIBUTING.md: add treewide change syntax
ckiee Dec 6, 2021
8709490
doc/manual: add treewide change syntax
ckiee Dec 6, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ under the terms of [COPYING](COPYING), which is an MIT-like license.
* Format the commit messages in the following way:

```
(pkg-name | nixos/<module>): (from -> to | init at version | refactor | etc)
((<pkg-name> | treewide) | nixos/(<module> | treewide)): (from -> to | init at version | refactor | etc)

(Motivation for change. Additional information.)
```
Expand All @@ -28,6 +28,8 @@ under the terms of [COPYING](COPYING), which is an MIT-like license.
* nixos/hydra: add bazBaz option

Dual baz behavior is needed to do foo.
* nixos/treewide: escape pkgs reference in examples and descriptions
* treewide: gnome2.gtk -> gtk2
* nixos/nginx: refactor config generation

The old config generation system used impure shell scripts and could break in specific circumstances (see #1234).
Expand All @@ -42,6 +44,10 @@ under the terms of [COPYING](COPYING), which is an MIT-like license.

See the nixpkgs manual for more details on [standard meta-attributes](https://nixos.org/nixpkgs/manual/#sec-standard-meta-attributes) and on how to [submit changes to nixpkgs](https://nixos.org/nixpkgs/manual/#chap-submitting-changes).

### Treewide changes

Changes that affect a large portion of the tree should be prefixed with `treewide:` or `nixos/treewide`.

## Writing good commit messages

In addition to writing properly formatted commit messages, it's important to include relevant information so other developers can later understand *why* a change was made. While this information usually can be found by digging code, mailing list/Discourse archives, pull request discussions or upstream changes, it may require a lot of work.
Expand Down
4 changes: 3 additions & 1 deletion doc/contributing/submitting-changes.chapter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,16 @@
- Format the commit in a following way:

```
(pkg-name | nixos/<module>): (from -> to | init at version | refactor | etc)
((<pkg-name> | treewide) | nixos/(<module> | treewide)): (from -> to | init at version | refactor | etc)
Additional information.
```

- Examples:
- `nginx: init at 2.0.1`
- `firefox: 54.0.1 -> 55.0`
- `nixos/hydra: add bazBaz option`
- `nixos/treewide: escape pkgs reference in examples and descriptions`
- `treewide: gnome2.gtk -> gtk2`
- `nixos/nginx: refactor config generation`

- Test your changes. If you work with
Expand Down