Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simple Clean up, .gitignore improved, PR template added #227

Merged
merged 15 commits into from
Nov 20, 2023
Merged
28 changes: 28 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
## Summary

> What is the reason for this Pull-Request? Are you bumping the version?
smttsp marked this conversation as resolved.
Show resolved Hide resolved



## Impact

> What is the scope of your changes and who/where do you think they will affect?



## Testing

> What testing have you done and verified? If you can't test, please say why that is.
smttsp marked this conversation as resolved.
Show resolved Hide resolved

-

## Ticket(s) or Conversations

> What Git or Slack items (Issues, threads etc) are specifically related to this work? Please link them here.


## References

> Do you have any relevant URLs or Wiki pages that could help give background information for the changes in this Pull-Request? These are usually StackOverflow posts, Notion wiki pages, Wikipedia articles, or links to APIs and Documentation of third-party packages.
smttsp marked this conversation as resolved.
Show resolved Hide resolved

-
133 changes: 132 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
.idea/
.DS_Store
__pycache__/
smttsp marked this conversation as resolved.
Show resolved Hide resolved
.vscode/
Expand All @@ -21,3 +20,135 @@ image_files*

# datasets
cifar*

# Byte-compiled / optimized / DLL files
*.py[cod]
*$py.class
.direnv
.idea
.idea/**
.vscode
.vscode/**

# C extensions
*.so
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is not valid in this repo, please remove this

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

many of these are very common stuff in gitignore, in fact, most of these lines are coming from Github's default Python gitignore.

I found being proactive much more effective than being retroactive. We will add common things now, but we won't need to add them to gitignore if/when it happens.

Note that prior to this PR, when I set up my environment, I was seeing 30K files to be committed as the ENV (default) directory wasn't in gitignore.

**.txt
jwmueller marked this conversation as resolved.
Show resolved Hide resolved

# Distribution / packaging
.Python
develop-eggs/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
pip-wheel-metadata/
share/python-wheels/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is not valid in this repo, please remove this

# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not valid in this repo, please remove this

pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage*
.cache
nosetests.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/

# Translations
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not valid in this repo, please remove this

*.mo
*.pot

# Django stuff:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not valid in this repo, please remove this

*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not valid in this repo, please remove this

instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
target/
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not valid in this repo, please remove this


# IPython
profile_default/
ipython_config.py

__pypackages__/

# Celery stuff
celerybeat-schedule
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not valid in this repo, please remove this

celerybeat.pid

# SageMath parsed files
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not valid in this repo, please remove this

*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not valid in this repo, please remove this

.spyderproject
.spyproject

# Rope project settings
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not valid in this repo, please remove this

.ropeproject

# mkdocs documentation
/site
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not valid in this repo, please remove this


# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# Data files
smttsp marked this conversation as resolved.
Show resolved Hide resolved
**/*.json
*.csv
**.zip
**-ubyte
**.gz

outputs/*
**.pth
**.pt
_data/**
_model/**
wandb/**

ENV/**