cbrnr / sleepecg

Sleep stage detection using ECG
BSD 3-Clause "New" or "Revised" License
86 stars 22 forks source link

Clean .gitignore #179

Closed cbrnr closed 1 year ago

cbrnr commented 1 year ago

I think we don't need to foresee every file we might want to ignore depending on which IDE or other tools someone uses. These should go into .gitignore_global, so currently only *.so remains (because this is part of the package, but should not be under source control).

For example, my .gitignore_global looks like this:

.DS_Store
.idea
.vscode
.venv
.envrc
.direnv
__pycache__
.mypy_cache
.pytest_cache
.ruff_cache
.ipynb_checkpoints
*.egg-info

@hofaflo WDYT?

cbrnr commented 1 year ago

Alternatively, we could also argue that we should ignore all files that running/developing/... SleepECG produces, such as .pytest_cache (we're running Pytest when developing), .mypy_cache (same), .ruff_cache (same), etc.

I kind of prefer this option on second thought.

hofaflo commented 1 year ago

I also prefer the second option. I'd argue that this should include a few more entries:

cbrnr commented 1 year ago

Done! I've excluded sleepecg.egg-info (with a - instead of an _), because that's what's being created on my macOS and Linux machines. If it's different on Windows please LMK.

hofaflo commented 1 year ago

Ah yes, the _ was a typo, perfect!