commit 75f4709fe3835d56cee1860696fa421d96165b6e · pyrox.dev/nixpkgs

+14 -13
CONTRIBUTING.md
···

       3
       3
        
       ## Opening issues

     

       4
       4
        
       

     

       5
       5
        
       * Make sure you have a [GitHub account](https://github.com/signup/free)

     

       6
       6
       -
       * Submit a ticket for your issue, assuming one does not already exist.

     

       7
       7
       -
         * Clearly describe the issue including steps to reproduce when it is a bug.

     

       6
       6
       +
       * [Submit an issue](https://github.com/NixOS/nixpkgs/issues) - assuming one does not already exist

     

       7
       7
       +
         * Clearly describe the issue including steps to reproduce when it is a bug

     

       8
       8
       +
         * Include information what version of nixpkgs and Nix are you using (nixos-version or git revision)

     

       8
       9
        
       

     

       9
       10
        
       ## Making patches

     

       10
       11
        
       

     

       11
       12
        
       * Read [Manual (How to write packages for Nix)](https://nixos.org/nixpkgs/manual/)

     

       12
       13
        
       * Fork the repository on GitHub.

     

       13
       14
        
       * Create a branch for your future fix.

     

       14
       14
       -
         * You can make branch from a commit of your local `nixos-version`. That will help you to avoid additional local compilations. Because you will recieve some packages from cache server.

     

       15
       15
       +
         * You can make branch from a commit of your local `nixos-version`. That will help you to avoid additional local compilations. Because you will recieve packages from binary cache.

     

       15
       16
        
           * For example: `nixos-version` returns `15.05.git.0998212 (Dingo)`. So you can do:

     

       16
       17
        
       

     

       17
       18
        
               ```bash

     
···

       20
       21
        
               ```

     

       21
       22
        
         * Please avoid working directly on the `master` branch.

     

       22
       23
        
       * Make commits of logical units. 

     

       23
       23
       -
         * If you removed pkgs, made some major changes etc., write about them in `nixos/doc/manual/release-notes/rl-unstable.xml`.

     

       24
       24
       +
         * If you removed pkgs, made some major NixOS changes etc., write about them in `nixos/doc/manual/release-notes/rl-unstable.xml`.

     

       24
       25
        
       * Check for unnecessary whitespace with `git diff --check` before committing.

     

       25
       26
        
       * Format the commit in a following way:

     

       26
       27
        
       

     

       27
       28
        
               ```

     

       28
       28
       -
               (pkg-name | service-name): (update from -> to | init at version | refactor | etc)

     

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

     

       29
       30
        
       

     

       30
       31
        
               Additional information.

     

       31
       32
        
               ```

     

       32
       33
        
         * Examples:

     

       33
       34
        
           * `nginx: init at 2.0.1`

     

       34
       34
       -
           * `firefox: update 3.0 -> 3.1.1`

     

       35
       35
       +
           * `firefox: 3.0 -> 3.1.1`

     

       35
       36
        
           * `hydra service: add bazBaz option`

     

       36
       37
        
           * `nginx service: refactor config generation`

     

       37
       38
        
       * Test your changes. If you work with 

     

       38
       38
       -
         * nixpkgs

     

       39
       39
       +
         a) nixpkgs

     

       39
       40
        
           * update pkg -> 

     

       40
       41
        
             * `nix-env -i pkg-name -f <path to your local nixpkgs folder>`

     

       41
       42
        
           * add pkg -> 

     
···

       44
       45
        
           * _If you don't want to install pkg in you profile_. 

     

       45
       46
        
             * `nix-build -A pkg-attribute-name <path to your local nixpkgs folder>/default.nix` and check results in the folder `result`. It will appear in the same directory where you did `nix-build`.

     

       46
       47
        
           * If you did `nix-env -i pkg-name` you can do `nix-env -e pkg-name` to uninstall it from your system.

     

       47
       47
       -
         * nixos and its modules

     

       48
       48
       -
           * You can add new module to you `nixos-configuration file` (usually it's `/etc/nixos/configuration.nix`.  

     

       48
       48
       +
         b) NixOS and its modules

     

       49
       49
       +
           * You can add new module to your NixOS configuration file (usually it's `/etc/nixos/configuration.nix`.

     

       49
       50
        
           And do `sudo nixos-rebuild test -I nixpkgs=<path to your local nixpkgs folder> --fast`

     

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

     

       51
       52
        
       * Rebase you branch against current `master`.

     
···

       57
       58
        
         * Write the title in format `(pkg-name | service): improvement`

     

       58
       59
        
           * If you update the pkg, write versions `from -> to`

     

       59
       60
        
         * Write in comment if you have tested your patch. Do not rely much on `TravisCI`.

     

       60
       60
       -
         * If you make an improvement, write why is it good.

     

       61
       61
       +
         * If you make an improvement, write about your motivation

     

       61
       62
        
         * Notify maintainers of the package. For example add to the message: `cc @jagajaga @domenkozar`

     

       62
       63
        
       

     

       63
       64
        
       ## Hotfixing pull requests

     

       64
       65
        
       

     

       65
       65
       -
       * Make the appropriate changes in you branch.

     

       66
       66
       -
       * Don't create additional commits.

     

       66
       66
       +
       * Make the appropriate changes in you branch

     

       67
       67
       +
       * Don't create additional commits

     

       67
       68
        
         * `git rebase`

     

       68
       68
       -
         * `git push --force` to your branch.

     

       69
       69
       +
         * `git push --force` to your branch