natalie
/
nixpkgs-custom
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

nixpkgs docs: normalize

release-18.03-flake
Graham Christensen 2018-08-27 20:03:04 -04:00
parent 720dcd4e2b
commit 0e9b83fb89
No known key found for this signature in database
GPG Key ID: ACA1C1D120C83D5C
1 changed files with 19 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
doc/reviewing-contributions.xml
View File

@ -6,18 +6,20 @@
<title>Reviewing contributions</title> <title>Reviewing contributions</title>
<warning> <warning>
<para> <para>
The following section is a draft, and the policy for reviewing is still being The following section is a draft, and the policy for reviewing is still
discussed in issues such as <link being discussed in issues such as
<link
xlink:href="https://github.com/NixOS/nixpkgs/issues/11166">#11166 xlink:href="https://github.com/NixOS/nixpkgs/issues/11166">#11166
</link> and <link </link> and
<link
xlink:href="https://github.com/NixOS/nixpkgs/issues/20836">#20836 xlink:href="https://github.com/NixOS/nixpkgs/issues/20836">#20836
</link>. </link>.
</para> </para>
</warning> </warning>
<para> <para>
The nixpkgs project receives a fairly high number of contributions via The nixpkgs project receives a fairly high number of contributions via GitHub
GitHub pull-requests. Reviewing and approving these is an important task and pull-requests. Reviewing and approving these is an important task and a way
a way to contribute to the project. to contribute to the project.
</para> </para>
<para> <para>
The high change rate of nixpkgs makes any pull request that remains open for The high change rate of nixpkgs makes any pull request that remains open for
@ -38,10 +40,10 @@
to respect every community member and their work. to respect every community member and their work.
</para> </para>
<para> <para>
GitHub provides reactions as a simple and quick way to provide GitHub provides reactions as a simple and quick way to provide feedback to
feedback to pull-requests or any comments. The thumb-down reaction should be pull-requests or any comments. The thumb-down reaction should be used with
used with care and if possible accompanied with some explanation so the care and if possible accompanied with some explanation so the submitter has
submitter has directions to improve their contribution. directions to improve their contribution.
</para> </para>
<para> <para>
Pull-request reviews should include a list of what has been reviewed in a Pull-request reviews should include a list of what has been reviewed in a
@ -101,8 +103,9 @@
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
mention-bot usually notifies GitHub users based on the submitted changes, mention-bot usually notifies GitHub users based on the submitted
but it can happen that it misses some of the package maintainers. changes, but it can happen that it misses some of the package
maintainers.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -114,8 +117,8 @@
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
License can change with version updates, so it should be checked to match License can change with version updates, so it should be checked to
the upstream license. match the upstream license.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
@ -140,8 +143,8 @@
<listitem> <listitem>
<para> <para>
Pull-requests are often targeted to the master or staging branch, and Pull-requests are often targeted to the master or staging branch, and
building the pull-request locally when it is submitted can trigger building the pull-request locally when it is submitted can trigger many
many source builds. source builds.
</para> </para>
<para> <para>
It is possible to rebase the changes on nixos-unstable or It is possible to rebase the changes on nixos-unstable or