From 7079791ab6058c544dd8dde60294b69e02a6dcf8 Mon Sep 17 00:00:00 2001 From: Jarry Shaw Date: Mon, 11 Mar 2019 20:12:02 +0800 Subject: [PATCH] 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 github/gitignore#2977 by @drothmaler ) * Apply suggestions from code review Co-Authored-By: JarryShaw * Update Python.gitignore As suggested by @shiftkey , elaborate on the problems that users might see with `Pipfile.lock`. --- Python.gitignore | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/Python.gitignore b/Python.gitignore index 0447b8bd..38ce4278 100644 --- 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