commit 7587849e4d72e293498c01f134152f15c28717e3 · pyrox.dev/nixpkgs

+1 -67

CONTRIBUTING.md

···

       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).

     

       9
       9
        
       

     

       10
       10
       -
       ## Making patches

     

       11
       11
       -
       

     

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

     

       13
       13
       -
       * Fork the repository on GitHub.

     

       14
       14
       -
       * Create a branch for your future fix.

     

       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.

     

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

     

       17
       17
       -
       

     

       18
       18
       -
               ```bash

     

       19
       19
       -
               git checkout 0998212

     

       20
       20
       -
               git checkout -b 'fix/pkg-name-update'

     

       21
       21
       -
               ```

     

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

     

       23
       23
       -
       * Make commits of logical units.

     

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

     

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

     

       26
       26
       -
       * Format the commit in a following way:

     

       27
       27
       -
       

     

       28
       28
       -
               ```

     

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

     

       30
       30
       -
       

     

       31
       31
       -
               Additional information.

     

       32
       32
       -
               ```

     

       33
       33
       -
         * Examples:

     

       34
       34
       -
           * `nginx: init at 2.0.1`

     

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

     

       36
       36
       -
           * `hydra service: add bazBaz option`

     

       37
       37
       -
           * `nginx service: refactor config generation`

     

       38
       38
       -
       * Test your changes. If you work with

     

       39
       39
       -
         * nixpkgs:

     

       40
       40
       -
           * update pkg ->

     

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

     

       42
       42
       -
           * add pkg ->

     

       43
       43
       -
             * Make sure it's in `pkgs/top-level/all-packages.nix`

     

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

     

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

     

       46
       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`.

     

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

     

       48
       48
       -
         * NixOS and its modules:

     

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

     

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

     

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

     

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

     

       53
       53
       -
       

     

       54
       10
        
       ## Submitting changes

     

       55
       11
        
       

     

       56
       56
       -
       * Push your changes to your fork of nixpkgs.

     

       57
       57
       -
       * Create pull request:

     

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

     

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

     

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

     

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

     

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

     

       63
       63
       -
       

     

       64
       64
       -
       ## Hotfixing pull requests

     

       65
       65
       -
       

     

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

     

       67
       67
       -
       * Don't create additional commits, do

     

       68
       68
       -
         * `git rebase -i`

     

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

     

       70
       70
       -
       

     

       71
       71
       -
       ## Commit policy

     

       72
       72
       -
       

     

       73
       73
       -
       * Commits must be sufficiently tested before being merged, both for the master and staging branches.

     

       74
       74
       -
       * Hydra builds for master and staging should not be used as testing platform, it's a build farm for changes that have been already tested.

     

       75
       75
       -
       * Master should only see non-breaking commits that do not cause mass rebuilds.

     

       76
       76
       -
       * Staging should only see non-breaking mass-rebuild commits. That means it's not to be used for testing, and changes must have been well tested already. [Read policy here](http://comments.gmane.org/gmane.linux.distributions.nixos/13447).

     

       77
       77
       -
       * If staging is already in a broken state, please refrain from adding extra new breakages. Stabilize it for a few days, merge into master, then resume development on staging. [Keep an eye on the staging evaluations here](http://hydra.nixos.org/jobset/nixpkgs/staging#tabs-evaluations).

     

       78
       78
       -
       * 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.

     

       12
       12
       +
       See the nixpkgs manual for details on how to [Submit changes to nixpkgs](http://nixos.org/nixpkgs/manual/#chap-submitting-changes).

doc/manual.xml

···

       18
       18
        
         <xi:include href="language-support.xml" />

     

       19
       19
        
         <xi:include href="package-notes.xml" />

     

       20
       20
        
         <xi:include href="coding-conventions.xml" />

     

       21
       21
       +
         <xi:include href="submitting-changes.xml" />

     

       21
       22
        
         <xi:include href="haskell-users-guide.xml" />

     

       22
       23
        
         <xi:include href="contributing.xml" />

     

       23
       24

+283

doc/submitting-changes.xml

···

       1
       1
       +
       <chapter xmlns="http://docbook.org/ns/docbook"

     

       2
       2
       +
                xmlns:xlink="http://www.w3.org/1999/xlink"

     

       3
       3
       +
                xml:id="chap-submitting-changes">

     

       4
       4
       +
       

     

       5
       5
       +
       <title>Submitting changes</title>

     

       6
       6
       +
       

     

       7
       7
       +
       <section>

     

       8
       8
       +
       <title>Making patches</title>

     

       9
       9
       +
       

     

       10
       10
       +
       <itemizedlist>

     

       11
       11
       +
       <listitem>

     

       12
       12
       +
       <para>Read <link xlink:href="https://nixos.org/nixpkgs/manual/">Manual (How to write packages for Nix)</link>.</para>

     

       13
       13
       +
       </listitem>

     

       14
       14
       +
       

     

       15
       15
       +
       <listitem>

     

       16
       16
       +
       <para>Fork the repository on GitHub.</para>

     

       17
       17
       +
       </listitem>

     

       18
       18
       +
       

     

       19
       19
       +
       <listitem>

     

       20
       20
       +
       <para>Create a branch for your future fix.

     

       21
       21
       +
       

     

       22
       22
       +
       <itemizedlist>

     

       23
       23
       +
       <listitem>

     

       24
       24
       +
       <para>You can make branch from a commit of your local <command>nixos-version</command>. That will help you to avoid additional local compilations. Because you will receive packages from binary cache.

     

       25
       25
       +
       

     

       26
       26
       +
       <itemizedlist>

     

       27
       27
       +
       <listitem>

     

       28
       28
       +
       <para>For example: <command>nixos-version</command> returns <command>15.05.git.0998212 (Dingo)</command>. So you can do:</para>

     

       29
       29
       +
       </listitem>

     

       30
       30
       +
       </itemizedlist>

     

       31
       31
       +
       

     

       32
       32
       +
       <screen>

     

       33
       33
       +
       $ git checkout 0998212

     

       34
       34
       +
       $ git checkout -b 'fix/pkg-name-update'

     

       35
       35
       +
       </screen>

     

       36
       36
       +
       </para>

     

       37
       37
       +
       </listitem>

     

       38
       38
       +
       

     

       39
       39
       +
       <listitem>

     

       40
       40
       +
       <para>Please avoid working directly on the <command>master</command> branch.</para>

     

       41
       41
       +
       </listitem>

     

       42
       42
       +
       </itemizedlist>

     

       43
       43
       +
       </para>

     

       44
       44
       +
       </listitem>

     

       45
       45
       +
       

     

       46
       46
       +
       <listitem>

     

       47
       47
       +
       <para>Make commits of logical units.

     

       48
       48
       +
       

     

       49
       49
       +
       <itemizedlist>

     

       50
       50
       +
       <listitem>

     

       51
       51
       +
       <para>If you removed pkgs, made some major NixOS changes etc., write about them in <command>nixos/doc/manual/release-notes/rl-unstable.xml</command>.</para>

     

       52
       52
       +
       </listitem>

     

       53
       53
       +
       </itemizedlist>

     

       54
       54
       +
       </para>

     

       55
       55
       +
       </listitem>

     

       56
       56
       +
       

     

       57
       57
       +
       <listitem>

     

       58
       58
       +
       <para>Check for unnecessary whitespace with <command>git diff --check</command> before committing.</para>

     

       59
       59
       +
       </listitem>

     

       60
       60
       +
       

     

       61
       61
       +
       <listitem>

     

       62
       62
       +
       <para>Format the commit in a following way:</para>

     

       63
       63
       +
       <programlisting>

     

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

     

       65
       65
       +
       Additional information.

     

       66
       66
       +
       </programlisting>

     

       67
       67
       +
       

     

       68
       68
       +
       <itemizedlist>

     

       69
       69
       +
       <listitem>

     

       70
       70
       +
       <para>Examples:

     

       71
       71
       +
       

     

       72
       72
       +
       <itemizedlist>

     

       73
       73
       +
       <listitem>

     

       74
       74
       +
       <para>

     

       75
       75
       +
       <command>nginx: init at 2.0.1</command>

     

       76
       76
       +
       </para>

     

       77
       77
       +
       </listitem>

     

       78
       78
       +
       

     

       79
       79
       +
       <listitem>

     

       80
       80
       +
       <para>

     

       81
       81
       +
       <command>firefox: 3.0 -> 3.1.1</command>

     

       82
       82
       +
       </para>

     

       83
       83
       +
       </listitem>

     

       84
       84
       +
       

     

       85
       85
       +
       <listitem>

     

       86
       86
       +
       <para>

     

       87
       87
       +
       <command>hydra service: add bazBaz option</command>

     

       88
       88
       +
       </para>

     

       89
       89
       +
       </listitem>

     

       90
       90
       +
       

     

       91
       91
       +
       <listitem>

     

       92
       92
       +
       <para>

     

       93
       93
       +
       <command>nginx service: refactor config generation</command>

     

       94
       94
       +
       </para>

     

       95
       95
       +
       </listitem>

     

       96
       96
       +
       </itemizedlist>

     

       97
       97
       +
       </para>

     

       98
       98
       +
       </listitem>

     

       99
       99
       +
       </itemizedlist>

     

       100
       100
       +
       </listitem>

     

       101
       101
       +
       

     

       102
       102
       +
       <listitem>

     

       103
       103
       +
       <para>Test your changes. If you work with

     

       104
       104
       +
       

     

       105
       105
       +
       <itemizedlist>

     

       106
       106
       +
       <listitem>

     

       107
       107
       +
       <para>nixpkgs:

     

       108
       108
       +
       

     

       109
       109
       +
       <itemizedlist>

     

       110
       110
       +
       <listitem>

     

       111
       111
       +
       <para>update pkg ->

     

       112
       112
       +
       

     

       113
       113
       +
       <itemizedlist>

     

       114
       114
       +
       <listitem>

     

       115
       115
       +
       <para>

     

       116
       116
       +
       <command>nix-env -i pkg-name -f &lt;path to your local nixpkgs folder&gt;</command>

     

       117
       117
       +
       </para>

     

       118
       118
       +
       </listitem>

     

       119
       119
       +
       </itemizedlist>

     

       120
       120
       +
       </para>

     

       121
       121
       +
       </listitem>

     

       122
       122
       +
       

     

       123
       123
       +
       <listitem>

     

       124
       124
       +
       <para>add pkg ->

     

       125
       125
       +
       

     

       126
       126
       +
       <itemizedlist>

     

       127
       127
       +
       <listitem>

     

       128
       128
       +
       <para>Make sure it's in <command>pkgs/top-level/all-packages.nix</command>

     

       129
       129
       +
       </para>

     

       130
       130
       +
       </listitem>

     

       131
       131
       +
       

     

       132
       132
       +
       <listitem>

     

       133
       133
       +
       <para>

     

       134
       134
       +
       <command>nix-env -i pkg-name -f &lt;path to your local nixpkgs folder&gt;</command>

     

       135
       135
       +
       </para>

     

       136
       136
       +
       </listitem>

     

       137
       137
       +
       </itemizedlist>

     

       138
       138
       +
       </para>

     

       139
       139
       +
       </listitem>

     

       140
       140
       +
       

     

       141
       141
       +
       <listitem>

     

       142
       142
       +
       <para>

     

       143
       143
       +
       <emphasis>If you don't want to install pkg in you profile</emphasis>.

     

       144
       144
       +
       

     

       145
       145
       +
       <itemizedlist>

     

       146
       146
       +
       <listitem>

     

       147
       147
       +
       <para>

     

       148
       148
       +
       <command>nix-build -A pkg-attribute-name &lt;path to your local nixpkgs folder&gt;/default.nix</command> and check results in the folder <command>result</command>. It will appear in the same directory where you did <command>nix-build</command>.</para>

     

       149
       149
       +
       </listitem>

     

       150
       150
       +
       </itemizedlist>

     

       151
       151
       +
       </para>

     

       152
       152
       +
       </listitem>

     

       153
       153
       +
       

     

       154
       154
       +
       <listitem>

     

       155
       155
       +
       <para>If you did <command>nix-env -i pkg-name</command> you can do <command>nix-env -e pkg-name</command> to uninstall it from your system.</para>

     

       156
       156
       +
       </listitem>

     

       157
       157
       +
       </itemizedlist>

     

       158
       158
       +
       </para>

     

       159
       159
       +
       </listitem>

     

       160
       160
       +
       

     

       161
       161
       +
       <listitem>

     

       162
       162
       +
       <para>NixOS and its modules:

     

       163
       163
       +
       

     

       164
       164
       +
       <itemizedlist>

     

       165
       165
       +
       <listitem>

     

       166
       166
       +
       <para>You can add new module to your NixOS configuration file (usually it's <command>/etc/nixos/configuration.nix</command>).

     

       167
       167
       +
                   And do <command>sudo nixos-rebuild test -I nixpkgs=&lt;path to your local nixpkgs folder&gt; --fast</command>.</para>

     

       168
       168
       +
       </listitem>

     

       169
       169
       +
       </itemizedlist>

     

       170
       170
       +
       </para>

     

       171
       171
       +
       </listitem>

     

       172
       172
       +
       </itemizedlist>

     

       173
       173
       +
       </para>

     

       174
       174
       +
       </listitem>

     

       175
       175
       +
       

     

       176
       176
       +
       <listitem>

     

       177
       177
       +
       <para>If you have commits <command>pkg-name: oh, forgot to insert whitespace</command>: squash commits in this case. Use <command>git rebase -i</command>.</para>

     

       178
       178
       +
       </listitem>

     

       179
       179
       +
       

     

       180
       180
       +
       <listitem>

     

       181
       181
       +
       <para>Rebase you branch against current <command>master</command>.</para>

     

       182
       182
       +
       </listitem>

     

       183
       183
       +
       </itemizedlist>

     

       184
       184
       +
       </section>

     

       185
       185
       +
       

     

       186
       186
       +
       <section>

     

       187
       187
       +
       <title>Submitting changes</title>

     

       188
       188
       +
       

     

       189
       189
       +
       <itemizedlist>

     

       190
       190
       +
       <listitem>

     

       191
       191
       +
       <para>Push your changes to your fork of nixpkgs.</para>

     

       192
       192
       +
       </listitem>

     

       193
       193
       +
       

     

       194
       194
       +
       <listitem>

     

       195
       195
       +
       <para>Create pull request:

     

       196
       196
       +
       

     

       197
       197
       +
       <itemizedlist>

     

       198
       198
       +
       <listitem>

     

       199
       199
       +
       <para>Write the title in format <command>(pkg-name | service): improvement</command>.

     

       200
       200
       +
       

     

       201
       201
       +
       <itemizedlist>

     

       202
       202
       +
       <listitem>

     

       203
       203
       +
       <para>If you update the pkg, write versions <command>from -> to</command>.</para>

     

       204
       204
       +
       </listitem>

     

       205
       205
       +
       </itemizedlist>

     

       206
       206
       +
       </para>

     

       207
       207
       +
       </listitem>

     

       208
       208
       +
       

     

       209
       209
       +
       <listitem>

     

       210
       210
       +
       <para>Write in comment if you have tested your patch. Do not rely much on <command>TravisCI</command>.</para>

     

       211
       211
       +
       </listitem>

     

       212
       212
       +
       

     

       213
       213
       +
       <listitem>

     

       214
       214
       +
       <para>If you make an improvement, write about your motivation.</para>

     

       215
       215
       +
       </listitem>

     

       216
       216
       +
       

     

       217
       217
       +
       <listitem>

     

       218
       218
       +
       <para>Notify maintainers of the package. For example add to the message: <command>cc @jagajaga @domenkozar</command>.</para>

     

       219
       219
       +
       </listitem>

     

       220
       220
       +
       </itemizedlist>

     

       221
       221
       +
       </para>

     

       222
       222
       +
       </listitem>

     

       223
       223
       +
       </itemizedlist>

     

       224
       224
       +
       </section>

     

       225
       225
       +
       

     

       226
       226
       +
       <section>

     

       227
       227
       +
       <title>Hotfixing pull requests</title>

     

       228
       228
       +
       

     

       229
       229
       +
       <itemizedlist>

     

       230
       230
       +
       <listitem>

     

       231
       231
       +
       <para>Make the appropriate changes in you branch.</para>

     

       232
       232
       +
       </listitem>

     

       233
       233
       +
       

     

       234
       234
       +
       <listitem>

     

       235
       235
       +
       <para>Don't create additional commits, do

     

       236
       236
       +
       

     

       237
       237
       +
       <itemizedlist>

     

       238
       238
       +
       <listitem>

     

       239
       239
       +
       <para><command>git rebase -i</command></para>

     

       240
       240
       +
       </listitem>

     

       241
       241
       +
       <listitem>

     

       242
       242
       +
       <para>

     

       243
       243
       +
       <command>git push --force</command> to your branch.</para>

     

       244
       244
       +
       </listitem>

     

       245
       245
       +
       </itemizedlist>

     

       246
       246
       +
       </para>

     

       247
       247
       +
       </listitem>

     

       248
       248
       +
       

     

       249
       249
       +
       </itemizedlist>

     

       250
       250
       +
       </section>

     

       251
       251
       +
       

     

       252
       252
       +
       <section>

     

       253
       253
       +
       <title>Commit policy</title>

     

       254
       254
       +
       

     

       255
       255
       +
       <itemizedlist>

     

       256
       256
       +
       <listitem>

     

       257
       257
       +
       <para>Commits must be sufficiently tested before being merged, both for the master and staging branches.</para>

     

       258
       258
       +
       </listitem>

     

       259
       259
       +
       

     

       260
       260
       +
       <listitem>

     

       261
       261
       +
       <para>Hydra builds for master and staging should not be used as testing platform, it's a build farm for changes that have been already tested.</para>

     

       262
       262
       +
       </listitem>

     

       263
       263
       +
       

     

       264
       264
       +
       <listitem>

     

       265
       265
       +
       <para>Master should only see non-breaking commits that do not cause mass rebuilds.</para>

     

       266
       266
       +
       </listitem>

     

       267
       267
       +
       

     

       268
       268
       +
       <listitem>

     

       269
       269
       +
       <para>Staging should only see non-breaking mass-rebuild commits. That means it's not to be used for testing, and changes must have been well tested already. <link xlink:href="http://comments.gmane.org/gmane.linux.distributions.nixos/13447">Read policy here</link>.</para>

     

       270
       270
       +
       </listitem>

     

       271
       271
       +
       

     

       272
       272
       +
       <listitem>

     

       273
       273
       +
       <para>If staging is already in a broken state, please refrain from adding extra new breakages. Stabilize it for a few days, merge into master, then resume development on staging. <link xlink:href="http://hydra.nixos.org/jobset/nixpkgs/staging#tabs-evaluations">Keep an eye on the staging evaluations here</link>.</para>

     

       274
       274
       +
       </listitem>

     

       275
       275
       +
       

     

       276
       276
       +
       <listitem>

     

       277
       277
       +
       <para>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.</para>

     

       278
       278
       +
       </listitem>

     

       279
       279
       +
       </itemizedlist>

     

       280
       280
       +
       

     

       281
       281
       +
       </section>

     

       282
       282
       +
       </chapter>

     

       283
       283
       +