summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAnthony Sottile <asottile@umich.edu>2019-05-30 13:37:54 +0000
committerAnthony Sottile <asottile@umich.edu>2019-05-30 13:37:54 +0000
commit027ed1c9cc5087b611630aea08dd67a498e701a4 (patch)
treef4885a7227256006958180db341977109c2171bf
parent609693bb5cfdc16ab09332f69405eff4fb77ebef (diff)
parent78a4f4cda447cb3ea8113c1b2b6a5471ea6dc30c (diff)
downloadflake8-027ed1c9cc5087b611630aea08dd67a498e701a4.tar.gz
Merge branch 'doc/gitignore' into 'master'
Document global gitignore files for contributors Closes #155 See merge request pycqa/flake8!323
-rw-r--r--docs/source/internal/contributing.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/source/internal/contributing.rst b/docs/source/internal/contributing.rst
index 33757d0..d5c8d8d 100644
--- a/docs/source/internal/contributing.rst
+++ b/docs/source/internal/contributing.rst
@@ -165,6 +165,17 @@ Merge requests should:
- Follow the guidelines in :ref:`writing-code`
+- Avoid having :code:`.gitignore` file in your PR
+
+ Changes to :code:`.gitignore` will rarely be accepted.
+
+ If you need to add files to :code:`.gitignore` you have multiple options
+
+ - Create a global :code:`.gitignore` file
+ - Create/update :code:`.git/info/exclude` file.
+
+ Both these options are explained in detail `here <https://help.github.com/en/articles/ignoring-files#create-a-global-gitignore>`_
+
Reviewing and Triaging Issues and Merge Requests
================================================