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

smttsp · 2023-10-05T03:17:10Z

Summary

What is the reason for this Pull-Request?

This PR improves the .gitignore as well as adds a PR template to be filled in any PR created.

Added the following sections:

Byte-compiled / optimized / DLL files
development environment configuration files (.idea, .vscode)
Python Virtual Environments (common ones: venv, env, .direnv etc)
C/c++ extensions (.so)
Distribution / packaging (.egg, lib, lib64, wheels etc)
Installer logs
Unit test / coverage reports
log files
IPython (e.g. profile_default/)
mkdocs documentation
mypy caches
compressed files (zip, gz, tar, 7z etc)
other files (output, wandb)

Impact

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

improved gitignore
new template

Testing

What testing have you done and verified? If you can't test, please say why that is.

I have tested both locally
I am using the template now

Ticket(s) or Conversations

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

-N/A

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.

CLAassistant · 2023-10-05T03:17:16Z

All committers have signed the CLA.

smttsp

ready for review

.github/pull_request_template.md

Co-authored-by: Jonas Mueller <[email protected]>

.github/pull_request_template.md

Co-authored-by: Jonas Mueller <[email protected]>

.github/pull_request_template.md

.gitignore

codecov · 2023-10-05T04:08:09Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (9de8f33) 96.04% compared to head (37b0bd8) 95.84%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #227      +/-   ##
==========================================
- Coverage   96.04%   95.84%   -0.21%     
==========================================
  Files          16       16              
  Lines         986      986              
  Branches      194      194              
==========================================
- Hits          947      945       -2     
- Misses         20       21       +1     
- Partials       19       20       +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Co-authored-by: Jonas Mueller <[email protected]>

finalized the gitignore

jwmueller · 2023-10-06T05:59:46Z

@smttsp once you've finalized .github/pull_request_template.md

it would be awesome if you can also make a PR with the same template to cleanlab/cleanlab repo!

jwmueller

There was one overlooked suggestion, which you can commit, and then this LGTM.

Leaving final review + merge to @sanjanag who has relied on the .gitignore more than any other developer of this repo thus far.

smttsp · 2023-10-06T12:51:33Z

it would be awesome if you can also make a PR with the same template to cleanlab/cleanlab repo!

@jwmueller, would you like me to update gitignore as well?

sanjanag

Overall, please remove all unnecessary file escapes from the gitignore, it's hard to comment at each one of them.

.gitignore

smttsp · 2023-10-11T00:02:42Z

@sanjanag if there is anything in gitignore you wanna keep, I can keep them. Otherwise, I am dropping all the .gitignore related commits. I am not clear on what is needed, and what is not needed in this repo but most of these are pretty common stuff to ignore.

sanjanag · 2023-10-12T22:09:13Z

Hi @smttsp ! Your PR template looks good, We don't want to clutter the gitignore with supposedly "common stuff" that does not concern this repo. I'd recommend you only keep the following sections in the gitignore and remove the rest. Thank you.

# development environment configuration files
# Python Environments
# Distribution / packaging
# Data files

smttsp · 2023-10-12T22:44:24Z

@sanjanag would you like me to have the same exact changes as this one: https://github.com/cleanlab/cleanlab/pull/867/files, so it would be more consistent with the other repo?

sanjanag · 2023-10-16T21:27:44Z

.gitignore

-build/
+.installed.cfg
+*.egg
+MANIFEST


Does this line exclude MANIFEST.in?

No, it doesnt exclude

can you still remove it? I think it's confusing since we have a MANIFEST.in file

sanjanag · 2023-10-16T21:28:32Z

.gitignore

+*.cover
+.hypothesis/
+.pytest_cache/
+.coverage*


Does this line exclude .coveragerc?

yes, it excludes

We don't want to exclude it, can you please remove it?

sanjanag · 2023-10-16T21:29:07Z

.gitignore


 # Misc
 results/
 image_files*

 # datasets
 cifar*
+
+cleanlab/*.ipynb


this is not valid in this repo, please remove this

sanjanag · 2023-10-16T21:29:16Z

.gitignore


 # Misc
 results/
 image_files*

 # datasets
 cifar*
+
+cleanlab/*.ipynb
+tests/fasttext_data/


this is not valid in this repo, please remove this

sanjanag · 2023-10-16T21:29:26Z

.gitignore

+*$py.class
+
+# C extensions
+*.so


this is not valid in this repo, please remove this

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.

sanjanag · 2023-10-16T21:29:42Z

.gitignore

+*.so
+
+
+# PyInstaller


this is not valid in this repo, please remove this

sanjanag · 2023-10-16T21:30:49Z

.gitignore

+# mypy
+.mypy_cache/
+
+# Downloaded datasets for docs


This section is not valid in this repo, please remove this

sanjanag · 2023-10-16T21:31:05Z

.gitignore

+.spyderproject
+.spyproject
+
+# Rope project settings
