Skip to content

Commit

Permalink
Merge pull request #5338 from pfmoore/doc_cosmetic_pr
Browse files Browse the repository at this point in the history
Add a note to the docs about cosmetic changes in PRs
  • Loading branch information
pfmoore authored Apr 28, 2018
2 parents b4aa62a + 762ae03 commit 7012275
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions docs/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,13 @@ treated as "feature branches", with ongoing development work happening
within the PR. Instead, the feature should be broken up into smaller,
independent parts which can be reviewed and merged individually.

When creating a pull request, avoid including "cosmetic" changes to
code that is unrelated to your change, as these make reviewing the PR
more difficult. Examples include re-flowing text in comments or
documentation, or addition or removal of blank lines or whitespace
within lines. Such changes can be made separately, as a "formatting
cleanup" PR, if needed.


Automated Testing
=================
Expand Down Expand Up @@ -140,8 +147,10 @@ public is concerned, typo fixes, white space modification, etc. To mark a PR
as trivial a contributor simply needs to add a randomly named, empty file to
the ``news/`` directory with the extension of ``.trivial``. If you are on a
POSIX like operating system, one can be added by running
``touch news/$(uuidgen).trivial``. Core committers may also add a "trivial"
label to the PR which will accomplish the same thing.
``touch news/$(uuidgen).trivial``. On Windows, the same result can be achieved
in Powershell using ``New-Item "news/$([guid]::NewGuid()).trivial"``. Core
committers may also add a "trivial" label to the PR which will accomplish the
same thing.

Upgrading, removing, or adding a new vendored library gets a special mention
using a ``news/<library>.vendor`` file. This is in addition to any features,
Expand Down
Empty file.

0 comments on commit 7012275

Please sign in to comment.