From 0c1000af58429abe86c08943c3f53f2d73450425 Mon Sep 17 00:00:00 2001 From: Erik Sundell Date: Fri, 21 Jan 2022 11:14:49 +0100 Subject: [PATCH] Clarify whats manually added in .gitignore --- .gitignore | 39 +++++++++++++++++++++++++++++++-------- 1 file changed, 31 insertions(+), 8 deletions(-) diff --git a/.gitignore b/.gitignore index 4f611f8795..6ec0ba5c17 100644 --- a/.gitignore +++ b/.gitignore @@ -4,7 +4,15 @@ Chart.lock .env-* +# Documentation build assets +docs/tmp +docs/reference/terraform.md + + +# Python.gitignore below - Add exceptions above for easier maintenance +# https://github.com/github/gitignore/blob/main/Python.gitignore +# -------------------------------------------------------------------- # Byte-compiled / optimized / DLL files __pycache__/ @@ -28,7 +36,6 @@ parts/ sdist/ var/ wheels/ -pip-wheel-metadata/ share/python-wheels/ *.egg-info/ .installed.cfg @@ -58,6 +65,7 @@ coverage.xml *.py,cover .hypothesis/ .pytest_cache/ +cover/ # Translations *.mo @@ -80,6 +88,7 @@ instance/ docs/_build/ # PyBuilder +.pybuilder/ target/ # Jupyter Notebook @@ -90,7 +99,9 @@ profile_default/ ipython_config.py # pyenv -.python-version +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version # pipenv # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. @@ -99,6 +110,13 @@ ipython_config.py # install all needed dependencies. #Pipfile.lock +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + # PEP 582; used by e.g. github.com/David-OConnor/pyflow __pypackages__/ @@ -136,10 +154,15 @@ dmypy.json # Pyre type checker .pyre/ -# helm charts -hub/charts -support/charts +# pytype static type analyzer +.pytype/ -# Documentation build assets -docs/tmp -docs/reference/terraform.md \ No newline at end of file +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintainted in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/