commit e93a3d7b586022f900f176cf46e7a3bf211cfaf9 · pyrox.dev/nixpkgs

+10 -23

CONTRIBUTING.md

···

       322
       322
        
       

     

       323
       323
        
       To get more information about how to review specific parts of Nixpkgs, refer to the documents linked to in the [overview section][overview].

     

       324
       324
        
       

     

       325
       325
       +
       If a pull request contains documentation changes that might require feedback from the documentation team, ping @NixOS/documentation-team on the pull request.

     

       326
       326
       +
       

     

       325
       327
        
       If you consider having enough knowledge and experience in a topic and would like to be a long-term reviewer for related submissions, please contact the current reviewers for that topic. They will give you information about the reviewing process. The main reviewers for a topic can be hard to find as there is no list, but checking past pull requests to see who reviewed or git-blaming the code to see who committed to that topic can give some hints.

     

       326
       328
        
       

     

       327
       329
        
       Container system, boot system and library changes are some examples of the pull requests fitting this category.

     
···

       512
       514
        
       

     

       513
       515
        
       - If you have commits `pkg-name: oh, forgot to insert whitespace`: squash commits in this case. Use `git rebase -i`.

     

       514
       516
        
       

     

       515
       515
       -
       - Format the commit messages in the following way:

     

       516
       516
       -
       

     

       517
       517
       -
         ```

     

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

     

       519
       519
       -
       

     

       520
       520
       -
         (Motivation for change. Link to release notes. Additional information.)

     

       521
       521
       -
         ```

     

       522
       522
       -
       

     

       523
       523
       -
         For consistency, there should not be a period at the end of the commit message's summary line (the first line of the commit message).

     

       524
       524
       -
       

     

       525
       525
       -
         Examples:

     

       526
       526
       -
       

     

       527
       527
       -
         * nginx: init at 2.0.1

     

       528
       528
       -
         * firefox: 54.0.1 -> 55.0

     

       517
       517
       +
       - For consistency, there should not be a period at the end of the commit message's summary line (the first line of the commit message).

     

       529
       518
        
       

     

       530
       530
       -
           https://www.mozilla.org/en-US/firefox/55.0/releasenotes/

     

       531
       531
       -
         * nixos/hydra: add bazBaz option

     

       532
       532
       -
       

     

       533
       533
       -
           Dual baz behavior is needed to do foo.

     

       534
       534
       -
         * nixos/nginx: refactor config generation

     

       535
       535
       -
       

     

       536
       536
       -
           The old config generation system used impure shell scripts and could break in specific circumstances (see #1234).

     

       537
       537
       -
       

     

       538
       538
       -
         When adding yourself as maintainer, in the same pull request, make a separate

     

       519
       519
       +
       - When adding yourself as maintainer in the same pull request, make a separate

     

       539
       520
        
         commit with the message `maintainers: add <handle>`.

     

       540
       521
        
         Add the commit before those making changes to the package or module.

     

       541
       522
        
         See [Nixpkgs Maintainers](./maintainers/README.md) for details.

     

       523
       523
       +
       

     

       524
       524
       +
       - Make sure you read about any commit conventions specific to the area you're touching. See:

     

       525
       525
       +
         - [Commit conventions](./pkgs/README.md#commit-conventions) for changes to `pkgs`.

     

       526
       526
       +
         - [Commit conventions](./lib/README.md#commit-conventions) for changes to `lib`.

     

       527
       527
       +
         - [Commit conventions](./nixos/README.md#commit-conventions) for changes to `nixos`.

     

       528
       528
       +
         - [Commit conventions](./doc/README.md#commit-conventions) for changes to `doc`, the Nixpkgs manual.

     

       542
       529
        
       

     

       543
       530
        
       ### Writing good commit messages

     

       544
       531

+21

doc/README.md

···

       114
       114
        
       watermelon

     

       115
       115
        
       :   green fruit with red flesh

     

       116
       116
        
       ```

     

       117
       117
       +
       

     

       118
       118
       +
       ## Commit conventions

     

       119
       119
       +
       

     

       120
       120
       +
       - Make sure you read about the [commit conventions](../CONTRIBUTING.md#commit-conventions) common to Nixpkgs as a whole.

     

       121
       121
       +
       

     

       122
       122
       +
       - If creating a commit purely for documentation changes, format the commit message in the following way:

     

       123
       123
       +
       

     

       124
       124
       +
         ```

     

       125
       125
       +
         doc: (documentation summary)

     

       126
       126
       +
       

     

       127
       127
       +
         (Motivation for change, relevant links, additional information.)

     

       128
       128
       +
         ```

     

       129
       129
       +
       

     

       130
       130
       +
         Examples:

     

       131
       131
       +
       

     

       132
       132
       +
         * doc: update the kernel config documentation to use `nix-shell`

     

       133
       133
       +
         * doc: add information about `nix-update-script`

     

       134
       134
       +
       

     

       135
       135
       +
           Closes #216321.

     

       136
       136
       +
       

     

       137
       137
       +
       - If the commit contains more than just documentation changes, follow the commit message format relevant for the rest of the changes.

+20

lib/README.md

···

       74
       74
        
       # Run the lib.fileset tests

     

       75
       75
        
       fileset/tests.sh

     

       76
       76
        
       ```

     

       77
       77
       +
       

     

       78
       78
       +
       ## Commit conventions

     

       79
       79
       +
       

     

       80
       80
       +
       - Make sure you read about the [commit conventions](../CONTRIBUTING.md#commit-conventions) common to Nixpkgs as a whole.

     

       81
       81
       +
       

     

       82
       82
       +
       - Format the commit messages in the following way:

     

       83
       83
       +
       

     

       84
       84
       +
         ```

     

       85
       85
       +
         lib.(section): (init | add additional argument | refactor | etc)

     

       86
       86
       +
       

     

       87
       87
       +
         (Motivation for change. Additional information.)

     

       88
       88
       +
         ```

     

       89
       89
       +
       

     

       90
       90
       +
         Examples:

     

       91
       91
       +
       

     

       92
       92
       +
         * lib.getExe': check arguments

     

       93
       93
       +
         * lib.fileset: Add an additional argument in the design docs

     

       94
       94
       +
       

     

       95
       95
       +
           Closes #264537

     

       96
       96
       +

+21

nixos/README.md

···

       8
       8
        
       

     

       9
       9
        
       You can add new module to your NixOS configuration file (usually it’s `/etc/nixos/configuration.nix`). And do `sudo nixos-rebuild test -I nixpkgs=<path to your local nixpkgs folder> --fast`.

     

       10
       10
        
       

     

       11
       11
       +
       ## Commit conventions

     

       12
       12
       +
       

     

       13
       13
       +
       - Make sure you read about the [commit conventions](../CONTRIBUTING.md#commit-conventions) common to Nixpkgs as a whole.

     

       14
       14
       +
       

     

       15
       15
       +
       - Format the commit messages in the following way:

     

       16
       16
       +
       

     

       17
       17
       +
         ```

     

       18
       18
       +
         nixos/(module): (init module | add setting | refactor | etc)

     

       19
       19
       +
       

     

       20
       20
       +
         (Motivation for change. Link to release notes. Additional information.)

     

       21
       21
       +
         ```

     

       22
       22
       +
       

     

       23
       23
       +
         Examples:

     

       24
       24
       +
       

     

       25
       25
       +
         * nixos/hydra: add bazBaz option

     

       26
       26
       +
       

     

       27
       27
       +
           Dual baz behavior is needed to do foo.

     

       28
       28
       +
         * nixos/nginx: refactor config generation

     

       29
       29
       +
       

     

       30
       30
       +
           The old config generation system used impure shell scripts and could break in specific circumstances (see #1234).

     

       31
       31
       +
       

     

       11
       32
        
       ## Reviewing contributions

     

       12
       33
        
       

     

       13
       34
        
       When changing the bootloader installation process, extra care must be taken. Grub installations cannot be rolled back, hence changes may break people’s installations forever. For any non-trivial change to the bootloader please file a PR asking for review, especially from \@edolstra.

+19

pkgs/README.md

···

       114
       114
        
       

     

       115
       115
        
       7. Optionally commit the new package and open a pull request [to nixpkgs](https://github.com/NixOS/nixpkgs/pulls), or use [the Patches category](https://discourse.nixos.org/t/about-the-patches-category/477) on Discourse for sending a patch without a GitHub account.

     

       116
       116
        
       

     

       117
       117
       +
       ## Commit conventions

     

       118
       118
       +
       

     

       119
       119
       +
       - Make sure you read about the [commit conventions](../CONTRIBUTING.md#commit-conventions) common to Nixpkgs as a whole.

     

       120
       120
       +
       

     

       121
       121
       +
       - Format the commit messages in the following way:

     

       122
       122
       +
       

     

       123
       123
       +
         ```

     

       124
       124
       +
         (pkg-name): (from -> to | init at version | refactor | etc)

     

       125
       125
       +
       

     

       126
       126
       +
         (Motivation for change. Link to release notes. Additional information.)

     

       127
       127
       +
         ```

     

       128
       128
       +
       

     

       129
       129
       +
         Examples:

     

       130
       130
       +
       

     

       131
       131
       +
         * nginx: init at 2.0.1

     

       132
       132
       +
         * firefox: 54.0.1 -> 55.0

     

       133
       133
       +
       

     

       134
       134
       +
           https://www.mozilla.org/en-US/firefox/55.0/releasenotes/

     

       135
       135
       +
       

     

       117
       136
        
       ## Category Hierarchy

     

       118
       137
        
       [categories]: #category-hierarchy

     

       119
       138