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

Add OS-specific files to .gitignore #57

Closed
ghost opened this issue Jun 15, 2019 · 10 comments · Fixed by #58
Closed

Add OS-specific files to .gitignore #57

ghost opened this issue Jun 15, 2019 · 10 comments · Fixed by #58

Comments

@ghost
Copy link

ghost commented Jun 15, 2019

I think that the default .gitignore file DrWatson generates should include the following OS-specific patterns:

.DS_Store
.DS_Store?
._*
.Spotlight-V100
.Trashes
ehthumbs.db
Thumbs.db

Also, ignore .ipynb_checkpoints for Jupyter Notebooks.
See
https://stackoverflow.com/questions/107701/how-can-i-remove-ds-store-files-from-a-git-repository
https://stackoverflow.com/questions/36306017/should-ipynb-checkpoints-be-stored-in-git

@ghost
Copy link
Author

ghost commented Jun 15, 2019

Also, in case somebody wants to use Documenter.jl, it should ignore docs/build

@asinghvi17
Copy link
Member

If you want to make a PR you can edit this file:

https://github.com/JuliaDynamics/DrWatson.jl/blob/master/src/defaults/gitignore.txt

@Datseris
Copy link
Member

yeah a pr would make you a contributor, which is cool!!!

@ghost
Copy link
Author

ghost commented Jun 15, 2019

At the moment, my company does not have a policy on open-source contributions, but management is looking into it. For now I don't want to patch something and risk it turning into an intellectual property dispute, causing problems for everyone.

@asinghvi17
Copy link
Member

asinghvi17 commented Jun 16, 2019

I was thinking we could do OS specific editing of the gitignore file at build as well, for MacOS especially.

https://coderwall.com/p/4yz8dq/determine-os-x-version-from-the-command-line

@Datseris
Copy link
Member

I think the complexity and first-run-time penalty of adding a build stage is not really worth it. There is almost zero drawback in adding the OS specific files for all users given that most of them start with .

@Datseris
Copy link
Member

But maybe I am wrong!

@ghost
Copy link
Author

ghost commented Jun 17, 2019

I think it would be simplest to just hardcode all of the known OS-specific filenames into the gitignore file. That way it doesn't matter who checks it out on what or if they migrate to a new system.

@asinghvi17
Copy link
Member

@cherbigmet, @Datseris: I took it a step too far, completely reworked the gitignore file...you can see the changes in the PR #58. I took a lot of data from gitignore.io, and mentioned it at the bottom of the file.

@ghost
Copy link
Author

ghost commented Jun 18, 2019

Wow! Well, if it passes, then it definitely takes care of my concerns, at which point, feel free to close this ticket.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants