commit a0aeb2381e5a6c5c57efdec1bf4b4ada44d29511 · pyrox.dev/nixpkgs

+98 -98

doc/reviewing-contributions.xml

···

       7
       7
        
       <title>Reviewing contributions</title>

     

       8
       8
        
       

     

       9
       9
        
       <warning>

     

       10
       10
       -
         <para>The following section is a draft and reviewing policy is still being 

     

       10
       10
       +
         <para>The following section is a draft and reviewing policy is still being

     

       11
       11
        
           discussed.</para>

     

       12
       12
        
       </warning>

     

       13
       13
        
       

     

       14
       14
       -
       <para>The nixpkgs projects receives a fairly high number of contributions via 

     

       15
       15
       -
         GitHub pull-requests. Reviewing and approving these is an important task and a 

     

       14
       14
       +
       <para>The nixpkgs projects receives a fairly high number of contributions via

     

       15
       15
       +
         GitHub pull-requests. Reviewing and approving these is an important task and a

     

       16
       16
        
         way to contribute to the project.</para>

     

       17
       17
        
       

     

       18
       18
       -
       <para>The high change rate of nixpkgs make any pull request that is open for 

     

       19
       19
       -
         long enough subject to conflicts that will require extra work from the 

     

       20
       20
       -
         submitter or the merger. Reviewing pull requests in a timely manner and being 

     

       21
       21
       -
         responsive to the comments is the key to avoid these. GitHub provides sort 

     

       22
       22
       -
         filters that can be used to see the <link 

     

       23
       23
       -
           xlink:href="https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc">most 

     

       24
       24
       -
           recently</link> and the <link 

     

       25
       25
       -
           xlink:href="https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-asc">least 

     

       18
       18
       +
       <para>The high change rate of nixpkgs make any pull request that is open for

     

       19
       19
       +
         long enough subject to conflicts that will require extra work from the

     

       20
       20
       +
         submitter or the merger. Reviewing pull requests in a timely manner and being

     

       21
       21
       +
         responsive to the comments is the key to avoid these. GitHub provides sort

     

       22
       22
       +
         filters that can be used to see the <link

     

       23
       23
       +
           xlink:href="https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc">most

     

       24
       24
       +
           recently</link> and the <link

     

       25
       25
       +
           xlink:href="https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-asc">least

     

       26
       26
        
           recently</link> updated pull-requests.</para>

     

       27
       27
        
       

     

       28
       28
       -
       <para>When reviewing a pull request, please always be nice and polite. 

     

       29
       29
       -
         Controversial changes can lead to controversial opinions, but it is important 

     

       28
       28
       +
       <para>When reviewing a pull request, please always be nice and polite.

     

       29
       29
       +
         Controversial changes can lead to controversial opinions, but it is important

     

       30
       30
        
         to respect every community members and their work.</para>

     

       31
       31
        
       

     

       32
       32
       -
       <para>GitHub provides reactions, they are a simple and quick way to provide 

     

       33
       33
       -
         feedback to pull-requests or any comments. The thumb-down reaction should be 

     

       34
       34
       -
         used with care and if possible accompanied with some explanations so the 

     

       32
       32
       +
       <para>GitHub provides reactions, they are a simple and quick way to provide

     

       33
       33
       +
         feedback to pull-requests or any comments. The thumb-down reaction should be

     

       34
       34
       +
         used with care and if possible accompanied with some explanations so the

     

       35
       35
        
         submitter has directions to improve his contribution.</para>

     

       36
       36
        
       

     

       37
       37
       -
       <para>Pull-requests reviews should include a list of what has been reviewed in a 

     

       38
       38
       -
         comment, so other reviewers and mergers can know the state of the 

     

       37
       37
       +
       <para>Pull-requests reviews should include a list of what has been reviewed in a

     

       38
       38
       +
         comment, so other reviewers and mergers can know the state of the

     

       39
       39
        
         review.</para>

     

       40
       40
        
       

     

       41
       41
       -
       <para>All the review template samples provided in this section are generic and 

     

       42
       42
       -
         meant as examples. Their usage is optional and the reviewer is free to adapt 

     

       41
       41
       +
       <para>All the review template samples provided in this section are generic and

     

       42
       42
       +
         meant as examples. Their usage is optional and the reviewer is free to adapt

     

       43
       43
        
         them to his liking.</para>

     

       44
       44
        
       

     

       45
       45
        
       <section><title>Package updates</title>

     

       46
       46
        
       

     

       47
       47
       -
       <para>A package update is the most trivial and common type of pull-request. 

     

       48
       48
       -
         These pull-requests mainly consist in updating the version part of the package 

     

       47
       47
       +
       <para>A package update is the most trivial and common type of pull-request.

     

       48
       48
       +
         These pull-requests mainly consist in updating the version part of the package

     

       49
       49
        
         name and the source hash.</para>

     

       50
       50
       -
       <para>It can happen that non trivial updates include patches or more complex 

     

       50
       50
       +
       <para>It can happen that non trivial updates include patches or more complex

     

       51
       51
        
         changes.</para>

     

       52
       52
        
       

     

       53
       53
        
       <para>Reviewing process:</para>

     

       54
       54
        
       

     

       55
       55
        
       <itemizedlist>

     

       56
       56
       -
         <listitem><para>Add labels to the pull-request. (Requires commit 

     

       56
       56
       +
         <listitem><para>Add labels to the pull-request. (Requires commit

     

       57
       57
        
             rights)</para>

     

       58
       58
        
           <itemizedlist>

     

       59
       59
       -
             <listitem><para><literal>8.has: package (update)</literal> and any topic 

     

       59
       59
       +
             <listitem><para><literal>8.has: package (update)</literal> and any topic

     

       60
       60
        
                 label that fit the updated package.</para></listitem>

     

       61
       61
        
           </itemizedlist>

     

       62
       62
        
         </listitem>

     

       63
       63
       -
         <listitem><para>Ensure that the package versioning is fitting the 

     

       63
       63
       +
         <listitem><para>Ensure that the package versioning is fitting the

     

       64
       64
        
             guidelines.</para></listitem>

     

       65
       65
       -
         <listitem><para>Ensure that the commit text is fitting the 

     

       65
       65
       +
         <listitem><para>Ensure that the commit text is fitting the

     

       66
       66
        
             guidelines.</para></listitem>

     

       67
       67
        
         <listitem><para>Ensure that the package maintainers are notified.</para>

     

       68
       68
        
           <itemizedlist>

     

       69
       69
       -
             <listitem><para>mention-bot usually notify GitHub users based on the 

     

       70
       70
       -
                 submitted changes, but it can happen that it misses some of the 

     

       69
       69
       +
             <listitem><para>mention-bot usually notify GitHub users based on the

     

       70
       70
       +
                 submitted changes, but it can happen that it misses some of the

     

       71
       71
        
                 package maintainers.</para></listitem>

     

       72
       72
        
           </itemizedlist>

     

       73
       73
        
         </listitem>

     

       74
       74
       -
         <listitem><para>Ensure that the meta field contains correct 

     

       74
       74
       +
         <listitem><para>Ensure that the meta field contains correct

     

       75
       75
        
             information.</para>

     

       76
       76
        
           <itemizedlist>

     

       77
       77
       -
             <listitem><para>License can change with version updates, so it should be 

     

       77
       77
       +
             <listitem><para>License can change with version updates, so it should be

     

       78
       78
        
                 checked to be fitting upstream license.</para></listitem>

     

       79
       79
       -
             <listitem><para>If the package has no maintainer, a maintainer must be 

     

       80
       80
       -
                 set. This can be the update submitter or a community member that 

     

       79
       79
       +
             <listitem><para>If the package has no maintainer, a maintainer must be

     

       80
       80
       +
                 set. This can be the update submitter or a community member that

     

       81
       81
        
                 accepts to take maintainership of the package.</para></listitem>

     

       82
       82
        
           </itemizedlist>

     

       83
       83
        
         </listitem>

     

       84
       84
        
         <listitem><para>Ensure that the code contains no typos.</para></listitem>

     

       85
       85
        
         <listitem><para>Building the package locally.</para>

     

       86
       86
        
           <itemizedlist>

     

       87
       87
       -
             <listitem><para>Pull-requests are often targeted to the master or staging 

     

       88
       88
       -
                 branch so building the pull-request locally as it is submitted can 

     

       87
       87
       +
             <listitem><para>Pull-requests are often targeted to the master or staging

     

       88
       88
       +
                 branch so building the pull-request locally as it is submitted can

     

       89
       89
        
                 trigger a large amount of source builds.</para>

     

       90
       90
       -
               <para>It is possible to rebase the changes on nixos-unstable or 

     

       91
       91
       -
                 nixpkgs-unstable for easier review by running the following commands 

     

       90
       90
       +
               <para>It is possible to rebase the changes on nixos-unstable or

     

       91
       91
       +
                 nixpkgs-unstable for easier review by running the following commands

     

       92
       92
        
                 from a nixpkgs clone.

     

       93
       93
        
       <screen>

     

       94
       94
       -
       $ git remote add channels https://github.com/NixOS/nixpkgs-channels.git <co 

     

       94
       94
       +
       $ git remote add channels https://github.com/NixOS/nixpkgs-channels.git <co

     

       95
       95
        
         xml:id='reviewing-rebase-1' />

     

       96
       96
        
       $ git fetch channels nixos-unstable <co xml:id='reviewing-rebase-2' />

     

       97
       97
        
       $ git fetch origin pull/PRNUMBER/head <co xml:id='reviewing-rebase-3' />

     

       98
       98
       -
       $ git rebase --onto nixos-unstable BASEBRANCH FETCH_HEAD <co 

     

       98
       98
       +
       $ git rebase --onto nixos-unstable BASEBRANCH FETCH_HEAD <co

     

       99
       99
        
         xml:id='reviewing-rebase-4' />

     

       100
       100
        
       </screen>

     

       101
       101
        
               <calloutlist>

     

       102
       102
        
                 <callout arearefs='reviewing-rebase-1'>

     

       103
       103
       -
                   <para>This should be done only once to be able to fetch channel 

     

       103
       103
       +
                   <para>This should be done only once to be able to fetch channel

     

       104
       104
        
                     branches from the nixpkgs-channels repository.</para>

     

       105
       105
        
                 </callout>

     

       106
       106
        
                 <callout arearefs='reviewing-rebase-2'>

     

       107
       107
        
                   <para>Fetching the nixos-unstable branch.</para>

     

       108
       108
        
                 </callout>

     

       109
       109
        
                 <callout arearefs='reviewing-rebase-3'>

     

       110
       110
       -
                   <para>Fetching the pull-request changes, <varname>PRNUMBER</varname> 

     

       111
       111
       -
                     is the number at the end of the pull-request title and 

     

       112
       112
       -
                     <varname>BASEBRANCH</varname> the base branch of the 

     

       110
       110
       +
                   <para>Fetching the pull-request changes, <varname>PRNUMBER</varname>

     

       111
       111
       +
                     is the number at the end of the pull-request title and

     

       112
       112
       +
                     <varname>BASEBRANCH</varname> the base branch of the

     

       113
       113
        
                     pull-request.</para>

     

       114
       114
        
                 </callout>

     

       115
       115
        
                 <callout arearefs='reviewing-rebase-3'>

     

       116
       116
       -
                   <para>Rebasing the pull-request changes to the nixos-unstable 

     

       116
       116
       +
                   <para>Rebasing the pull-request changes to the nixos-unstable

     

       117
       117
        
                     branch.</para>

     

       118
       118
        
                 </callout>

     

       119
       119
        
               </calloutlist>

     

       120
       120
        
               </para>

     

       121
       121
        
             </listitem>

     

       122
       122
        
             <listitem>

     

       123
       123
       -
               <para>The <link xlink:href="https://github.com/madjar/nox">nox</link> 

     

       124
       124
       -
                 tool can be used to review a pull-request content in a single command. 

     

       125
       125
       -
                 It doesn't rebase on a channel branch so it might trigger multiple 

     

       126
       126
       -
                 source builds. <varname>PRNUMBER</varname> should be replaced by the 

     

       123
       123
       +
               <para>The <link xlink:href="https://github.com/madjar/nox">nox</link>

     

       124
       124
       +
                 tool can be used to review a pull-request content in a single command.

     

       125
       125
       +
                 It doesn't rebase on a channel branch so it might trigger multiple

     

       126
       126
       +
                 source builds. <varname>PRNUMBER</varname> should be replaced by the

     

       127
       127
        
                 number at the end of the pull-request title.</para>

     

       128
       128
        
       <screen>

     

       129
       129
        
       $ nix-shell -p nox --run "nox-review -k pr PRNUMBER"

     
···

       153
       153
        
       

     

       154
       154
        
       <section><title>New packages</title>

     

       155
       155
        
       

     

       156
       156
       -
       <para>New packages are a common type of pull-requests. These pull requests 

     

       156
       156
       +
       <para>New packages are a common type of pull-requests. These pull requests

     

       157
       157
        
         consists in adding a new nix-expression for a package.</para>

     

       158
       158
        
       

     

       159
       159
        
       <para>Reviewing process:</para>

     

       160
       160
        
       

     

       161
       161
        
       <itemizedlist>

     

       162
       162
       -
         <listitem><para>Add labels to the pull-request. (Requires commit 

     

       162
       162
       +
         <listitem><para>Add labels to the pull-request. (Requires commit

     

       163
       163
        
             rights)</para>

     

       164
       164
        
           <itemizedlist>

     

       165
       165
       -
             <listitem><para><literal>8.has: package (new)</literal> and any topic 

     

       165
       165
       +
             <listitem><para><literal>8.has: package (new)</literal> and any topic

     

       166
       166
        
                 label that fit the new package.</para></listitem>

     

       167
       167
        
           </itemizedlist>

     

       168
       168
        
         </listitem>

     

       169
       169
       -
         <listitem><para>Ensure that the package versioning is fitting the 

     

       169
       169
       +
         <listitem><para>Ensure that the package versioning is fitting the

     

       170
       170
        
             guidelines.</para></listitem>

     

       171
       171
       -
         <listitem><para>Ensure that the commit name is fitting the 

     

       171
       171
       +
         <listitem><para>Ensure that the commit name is fitting the

     

       172
       172
        
             guidelines.</para></listitem>

     

       173
       173
       -
         <listitem><para>Ensure that the meta field contains correct 

     

       173
       173
       +
         <listitem><para>Ensure that the meta field contains correct

     

       174
       174
        
             information.</para>

     

       175
       175
        
           <itemizedlist>

     

       176
       176
       -
             <listitem><para>License must be checked to be fitting upstream 

     

       176
       176
       +
             <listitem><para>License must be checked to be fitting upstream

     

       177
       177
        
                 license.</para></listitem>

     

       178
       178
       -
             <listitem><para>Platforms should be set or the package will not get binary 

     

       178
       178
       +
             <listitem><para>Platforms should be set or the package will not get binary

     

       179
       179
        
                 substitutes.</para></listitem>

     

       180
       180
       -
             <listitem><para>A maintainer must be set, this can be the package 

     

       181
       181
       -
                 submitter or a community member that accepts to take maintainership of 

     

       180
       180
       +
             <listitem><para>A maintainer must be set, this can be the package

     

       181
       181
       +
                 submitter or a community member that accepts to take maintainership of

     

       182
       182
        
                 the package.</para></listitem>

     

       183
       183
        
           </itemizedlist>

     

       184
       184
        
         </listitem>

     

       185
       185
        
         <listitem><para>Ensure that the code contains no typos.</para></listitem>

     

       186
       186
        
         <listitem><para>Ensure the package source.</para>

     

       187
       187
        
           <itemizedlist>

     

       188
       188
       -
             <listitem><para>Mirrors urls should be used when 

     

       188
       188
       +
             <listitem><para>Mirrors urls should be used when

     

       189
       189
        
                 available.</para></listitem>

     

       190
       190
       -
             <listitem><para>The most appropriate function should be used (e.g. 

     

       191
       191
       -
                 packages from GitHub should use 

     

       190
       190
       +
             <listitem><para>The most appropriate function should be used (e.g.

     

       191
       191
       +
                 packages from GitHub should use

     

       192
       192
        
                 <literal>fetchFromGitHub</literal>).</para></listitem>

     

       193
       193
        
           </itemizedlist>

     

       194
       194
        
         </listitem>

     
···

       223
       223
        
       

     

       224
       224
        
       <section><title>Module updates</title>

     

       225
       225
        
       

     

       226
       226
       -
       <para>Module updates are submissions changing modules in some ways. These often 

     

       226
       226
       +
       <para>Module updates are submissions changing modules in some ways. These often

     

       227
       227
        
         contains changes to the options or introduce new options.</para>

     

       228
       228
        
       

     

       229
       229
        
       <para>Reviewing process</para>

     

       230
       230
        
       

     

       231
       231
        
       <itemizedlist>

     

       232
       232
       -
         <listitem><para>Add labels to the pull-request. (Requires commit 

     

       232
       232
       +
         <listitem><para>Add labels to the pull-request. (Requires commit

     

       233
       233
        
             rights)</para>

     

       234
       234
        
           <itemizedlist>

     

       235
       235
       -
             <listitem><para><literal>8.has: module (update)</literal> and any topic 

     

       235
       235
       +
             <listitem><para><literal>8.has: module (update)</literal> and any topic

     

       236
       236
        
                 label that fit the module.</para></listitem>

     

       237
       237
        
           </itemizedlist>

     

       238
       238
        
         </listitem>

     

       239
       239
        
         <listitem><para>Ensure that the module maintainers are notified.</para>

     

       240
       240
        
           <itemizedlist>

     

       241
       241
       -
             <listitem><para>Mention-bot notify GitHub users based on the submitted 

     

       242
       242
       -
                 changes, but it can happen that it miss some of the package 

     

       241
       241
       +
             <listitem><para>Mention-bot notify GitHub users based on the submitted

     

       242
       242
       +
                 changes, but it can happen that it miss some of the package

     

       243
       243
        
                 maintainers.</para></listitem>

     

       244
       244
        
           </itemizedlist>

     

       245
       245
        
         </listitem>

     

       246
       246
       -
         <listitem><para>Ensure that the module tests, if any, are 

     

       246
       246
       +
         <listitem><para>Ensure that the module tests, if any, are

     

       247
       247
        
             succeeding.</para></listitem>

     

       248
       248
        
         <listitem><para>Ensure that the introduced options are correct.</para>

     

       249
       249
        
           <itemizedlist>

     

       250
       250
       -
             <listitem><para>Type should be appropriate (string related types differs 

     

       251
       251
       -
                 in their merging capabilities, <literal>optionSet</literal> and 

     

       250
       250
       +
             <listitem><para>Type should be appropriate (string related types differs

     

       251
       251
       +
                 in their merging capabilities, <literal>optionSet</literal> and

     

       252
       252
        
                 <literal>string</literal> types are deprecated).</para></listitem>

     

       253
       253
       -
             <listitem><para>Description, default and example should be 

     

       253
       253
       +
             <listitem><para>Description, default and example should be

     

       254
       254
        
                 provided.</para></listitem>

     

       255
       255
        
           </itemizedlist>

     

       256
       256
        
         </listitem>

     

       257
       257
        
         <listitem><para>Ensure that option changes are backward compatible.</para>

     

       258
       258
        
           <itemizedlist>

     

       259
       259
       -
             <listitem><para><literal>mkRenamedOptionModule</literal> and 

     

       260
       260
       -
                 <literal>mkAliasOptionModule</literal> functions provide way to make 

     

       259
       259
       +
             <listitem><para><literal>mkRenamedOptionModule</literal> and

     

       260
       260
       +
                 <literal>mkAliasOptionModule</literal> functions provide way to make

     

       261
       261
        
                 option changes backward compatible.</para></listitem>

     

       262
       262
        
           </itemizedlist>

     

       263
       263
        
         </listitem>

     

       264
       264
       -
         <listitem><para>Ensure that removed options are declared with 

     

       264
       264
       +
         <listitem><para>Ensure that removed options are declared with

     

       265
       265
        
             <literal>mkRemovedOptionModule</literal></para></listitem>

     

       266
       266
       -
         <listitem><para>Ensure that changes that are not backward compatible are 

     

       266
       266
       +
         <listitem><para>Ensure that changes that are not backward compatible are

     

       267
       267
        
             mentioned in release notes.</para></listitem>

     

       268
       268
       -
         <listitem><para>Ensure that documentations affected by the change is 

     

       268
       268
       +
         <listitem><para>Ensure that documentations affected by the change is

     

       269
       269
        
             updated.</para></listitem>

     

       270
       270
        
       </itemizedlist>

     

       271
       271
        
       

     
···

       294
       294
        
       <para>New modules submissions introduce a new module to NixOS.</para>

     

       295
       295
        
       

     

       296
       296
        
       <itemizedlist>

     

       297
       297
       -
         <listitem><para>Add labels to the pull-request. (Requires commit 

     

       297
       297
       +
         <listitem><para>Add labels to the pull-request. (Requires commit

     

       298
       298
        
             rights)</para>

     

       299
       299
        
           <itemizedlist>

     

       300
       300
       -
             <listitem><para><literal>8.has: module (new)</literal> and any topic label 

     

       300
       300
       +
             <listitem><para><literal>8.has: module (new)</literal> and any topic label

     

       301
       301
        
                 that fit the module.</para></listitem>

     

       302
       302
        
           </itemizedlist>

     

       303
       303
        
         </listitem>

     

       304
       304
       -
         <listitem><para>Ensure that the module tests, if any, are 

     

       304
       304
       +
         <listitem><para>Ensure that the module tests, if any, are

     

       305
       305
        
             succeeding.</para></listitem>

     

       306
       306
        
         <listitem><para>Ensure that the introduced options are correct.</para>

     

       307
       307
        
           <itemizedlist>

     

       308
       308
       -
             <listitem><para>Type should be appropriate (string related types differs 

     

       309
       309
       -
                 in their merging capabilities, <literal>optionSet</literal> and 

     

       308
       308
       +
             <listitem><para>Type should be appropriate (string related types differs

     

       309
       309
       +
                 in their merging capabilities, <literal>optionSet</literal> and

     

       310
       310
        
                 <literal>string</literal> types are deprecated).</para></listitem>

     

       311
       311
       -
             <listitem><para>Description, default and example should be 

     

       311
       311
       +
             <listitem><para>Description, default and example should be

     

       312
       312
        
                 provided.</para></listitem>

     

       313
       313
        
           </itemizedlist>

     

       314
       314
        
         </listitem>

     

       315
       315
       -
         <listitem><para>Ensure that module <literal>meta</literal> field is 

     

       315
       315
       +
         <listitem><para>Ensure that module <literal>meta</literal> field is

     

       316
       316
        
             present</para>

     

       317
       317
        
           <itemizedlist>

     

       318
       318
       -
             <listitem><para>Maintainers should be declared in 

     

       318
       318
       +
             <listitem><para>Maintainers should be declared in

     

       319
       319
        
                 <literal>meta.maintainers</literal>.</para></listitem>

     

       320
       320
       -
             <listitem><para>Module documentation should be declared with 

     

       320
       320
       +
             <listitem><para>Module documentation should be declared with

     

       321
       321
        
                 <literal>meta.doc</literal>.</para></listitem>

     

       322
       322
        
           </itemizedlist>

     

       323
       323
        
         </listitem>

     

       324
       324
       -
         <listitem><para>Ensure that the module respect other modules 

     

       324
       324
       +
         <listitem><para>Ensure that the module respect other modules

     

       325
       325
        
             functionality.</para>

     

       326
       326
        
           <itemizedlist>

     

       327
       327
       -
             <listitem><para>For example, enabling a module should not open firewall 

     

       327
       327
       +
             <listitem><para>For example, enabling a module should not open firewall

     

       328
       328
        
                 ports by default.</para></listitem>

     

       329
       329
        
           </itemizedlist>

     

       330
       330
        
         </listitem>

     
···

       340
       340
        
       - [ ] options have default

     

       341
       341
        
       - [ ] options have example

     

       342
       342
        
       - [ ] options have descriptions

     

       343
       343
       -
       - [ ] No unneeded package is added to system.environmentPackages

     

       343
       343
       +
       - [ ] No unneeded package is added to environment.systemPackages

     

       344
       344
        
       - [ ] meta.maintainers is set

     

       345
       345
        
       - [ ] module documentation is declared in meta.doc

     

       346
       346
        
       

     
···

       355
       355
        
       

     

       356
       356
        
       <para>Other type of submissions requires different reviewing steps.</para>

     

       357
       357
        
       

     

       358
       358
       -
       <para>If you consider having enough knowledge and experience in a topic and 

     

       359
       359
       -
         would like to be a long-term reviewer for related submissions, please contact 

     

       360
       360
       -
         the current reviewers for that topic. They will give you information about the 

     

       358
       358
       +
       <para>If you consider having enough knowledge and experience in a topic and

     

       359
       359
       +
         would like to be a long-term reviewer for related submissions, please contact

     

       360
       360
       +
         the current reviewers for that topic. They will give you information about the

     

       361
       361
        
         reviewing process.

     

       362
       362
       -
       The main reviewers for a topic can be hard to find as there is no list, but 

     

       363
       363
       -
       checking past pull-requests to see who reviewed or git-blaming the code to see 

     

       362
       362
       +
       The main reviewers for a topic can be hard to find as there is no list, but

     

       363
       363
       +
       checking past pull-requests to see who reviewed or git-blaming the code to see

     

       364
       364
        
       who committed to that topic can give some hints.</para>

     

       365
       365
        
       

     

       366
       366
       -
       <para>Container system, boot system and library changes are some examples of the 

     

       366
       366
       +
       <para>Container system, boot system and library changes are some examples of the

     

       367
       367
        
         pull requests fitting this category.</para>

     

       368
       368
        
       

     

       369
       369
        
       </section>

     

       370
       370
        
       

     

       371
       371
        
       <section><title>Merging pull-requests</title>

     

       372
       372
        
       

     

       373
       373
       -
       <para>It is possible for community members that have enough knowledge and 

     

       373
       373
       +
       <para>It is possible for community members that have enough knowledge and

     

       374
       374
        
         experience on a special topic to contribute by merging pull requests.</para>

     

       375
       375
        
       

     

       376
       376
        
       <para>TODO: add the procedure to request merging rights.</para>

     
···

       380
       380
        
       proposition and should be modified to what the community agrees to be the right

     

       381
       381
        
       policy.

     

       382
       382
        
       

     

       383
       383
       -
       <para>Please note that contributors with commit rights unactive for more than 

     

       383
       383
       +
       <para>Please note that contributors with commit rights unactive for more than

     

       384
       384
        
         three months will have their commit rights revoked.</para>

     

       385
       385
        
       -->

     

       386
       386
        
       

     

       387
       387
       -
       <para>In a case a contributor leaves definitively the Nix community, he should 

     

       388
       388
       -
         create an issue or notify the mailing list with references of packages and 

     

       389
       389
       -
         modules he maintains so the maintainership can be taken over by other 

     

       387
       387
       +
       <para>In a case a contributor leaves definitively the Nix community, he should

     

       388
       388
       +
         create an issue or notify the mailing list with references of packages and

     

       389
       389
       +
         modules he maintains so the maintainership can be taken over by other

     

       390
       390
        
         contributors.</para>

     

       391
       391
        
       

     

       392
       392
        
       </section>

+1 -1

nixos/doc/manual/configuration/x-windows.xml

···

       130
       130
        
       <simplesect><title>GTK/Qt themes</title>

     

       131
       131
        
       

     

       132
       132
        
       <para>GTK themes can be installed either to user profile or system-wide (via

     

       133
       133
       -
       <literal>system.environmentPackages</literal>). To make Qt 5 applications look similar

     

       133
       133
       +
       <literal>environment.systemPackages</literal>). To make Qt 5 applications look similar

     

       134
       134
        
       to GTK2 ones, you can install <literal>qt5.qtbase.gtk</literal> package into your

     

       135
       135
        
       system environment. It should work for all Qt 5 library versions.

     

       136
       136
        
       </para>