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

Customize folders to be git-ignored #403

Open
fabiofortkamp opened this issue Feb 5, 2024 · 2 comments
Open

Customize folders to be git-ignored #403

fabiofortkamp opened this issue Feb 5, 2024 · 2 comments

Comments

@fabiofortkamp
Copy link
Contributor

Is your feature request related to a problem? Please describe.
I do not always agree with DrWatson's default options for the .gitignore file. I extensively use Quarto notebooks, which are leightweight enough to be included in version control, and my data files usually are small CSV and text files that can be included in the repository, so that everything is ready when the project is clone. So I always have to exclude the notebooks and data folders in the .gitignore file.

Describe the solution you'd like
I think that this file could be customized during project creation.

I actually have a working solution that modifies the initialize_project function with a new keyword option that accepts a vector of folders to be ignored (the default is everything that is currently in .gitignore). Should I submit a PR?

Describe alternatives you've considered
I guess the alternative would be to comply with the expected behavior and create a script to download the data files and host the notebooks in some external services, calling the functions in the DrWatson project I'm developing. For my small projects, this seems more trouble that it's worth.

@Datseris
Copy link
Member

Datseris commented Feb 5, 2024

I actually have a working solution that modifies the initialize_project function with a new keyword option that accepts a vector of folders to be ignored (the default is everything that is currently in .gitignore). Should I submit a PR?

yes please, this seems to me a valid and straightforward improvement!

@Datseris
Copy link
Member

Datseris commented Feb 5, 2024

Describe alternatives you've considered
I guess the alternative would be to comply with the expected behavior and create a script to download the data files and host the notebooks in some external services, calling the functions in the DrWatson project I'm developing. For my small projects, this seems more trouble that it's worth.

Modifying the .gitignore file seems like a much simpler alternative to this, but in any case allowing this at project construction is even better.

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

No branches or pull requests

2 participants