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_gitignore : adding .gitignore file #2611

Closed
wants to merge 2 commits into from
Closed

Conversation

bghimireamd
Copy link
Contributor

In this PR we add .gitignore file. Currently the ignores are related to documenation.

Copy link
Contributor

@amberhassaan amberhassaan left a comment

Choose a reason for hiding this comment

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

One question and rest is good.

_readthedocs/

# avoid duplicating contributing.md due to conf.py
docs/CHANGELOG.md
Copy link
Contributor

Choose a reason for hiding this comment

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

why are these lines needed? These could be legit files that we want in the repository.

@junliume
Copy link
Collaborator

junliume commented Dec 23, 2023

@bghimireamd @JehandadKhan @atamazov We discussed about .gitignore before and previously decided that it should be user specific and not provided by the repo, e.g. build does not necessarily reside in the same directory.
What has changed and now requiring us to add the file?

@atamazov
Copy link
Contributor

@junliume I do not know. I have my own .gitignore and do not need this.

@bghimireamd
Copy link
Contributor Author

bghimireamd commented Jan 4, 2024

@bghimireamd @JehandadKhan @atamazov We discussed about .gitignore before and previously decided that it should be user specific and not provided by the repo, e.g. build does not necessarily reside in the same directory. What has changed and now requiring us to add the file?

Oh! in that case we can place a hold on this PR. Documentation change was introduced by #2587 , which I believe generates some files during build process. To ignore those files this .gitinore was added.

We can have our own local .gitignore.

@CAHEK7
Copy link
Contributor

CAHEK7 commented Jan 4, 2024

The good practice is not generating anything in the source directory. Ideally it should be read-only.

@amberhassaan
Copy link
Contributor

My humble opinion is that it is common for projects to have a .gitignore that serves the need. Folks can modify this .gitignore locally or if I recall, there's a way to have a global .gitignore that users control: https://sebastiandedeyne.com/setting-up-a-global-gitignore-file/

@CAHEK7
Copy link
Contributor

CAHEK7 commented Jan 9, 2024

My humble opinion is that it is common for projects to have a .gitignore that serves the need.

It depends - if you don't generate anything in the build directory - you don't need default project .gitignore. No needs - no serve.

Each user makes .gitignore for himself based on a particular IDE or specific workflow - putting all possible combinations of IDE's temporary files and directories and something like build/* does not look like a good idea.

@junliume junliume deleted the add_gitignore branch June 25, 2024 05:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants