Add ignore rules for Pipenv (#2977)

* Add ignore rules for Pipenv Pipenv uses Pipfile.lock to maintain Python package information (metadata, hash, etc.) installed as described in Pipfile. Thus, Pipfile.lock may vary on different operating systems, platforms when collaborating. This PR adds Pipfile.lock into the Python default gitignore. See http://pipenv.org * Update Python.gitignore Not to ignore Pipfile.lock in default, but explain when and why it should be ignored in case of collaboration. (adjusted according to comment in #2977 by @drothmaler ) * Apply suggestions from code review Co-Authored-By: JarryShaw <[email protected]> * Update Python.gitignore As suggested by @shiftkey , elaborate on the problems that users might see with `Pipfile.lock`.
github · Mar 11, 2019 · 7079791 · 7079791
1 parent 23f7a81
commit 7079791
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/Python.gitignore b/Python.gitignore
@@ -82,6 +82,13 @@ ipython_config.py
 # pyenv
 .python-version
 
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don’t work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
 # celery beat schedule file
 celerybeat-schedule