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

Move the .README under .github folder #1

Open
kalkayan opened this issue Feb 13, 2022 · 1 comment
Open

Move the .README under .github folder #1

kalkayan opened this issue Feb 13, 2022 · 1 comment

Comments

@kalkayan
Copy link

Indeed leaving the README.md and other non-functional files creates a mess of the home directory. But if you would like to add README to your repo, you can move it under .github folder at the root of your repo.

Refer this - https://stackoverflow.com/questions/60507097/is-there-an-overview-of-what-can-go-into-a-github-dot-github-directory

@fperez
Copy link
Owner

fperez commented Feb 14, 2022

Thanks for the feedback, @kalkayan! I had originally considered doing this, but decided against it b/c I worried that specific name could collide with anyone's choices of having $HOME under version control itself separately. That's not a wise thing to do if you stuff everything, but someone could control $HOME with a suitable .gitignore that's very curated, and thus have a legit need for .github not to be overwritten.

Instead, I chose to put the minimal amount of clutter here: .README and .LICENSE and nothing else (the rest are real dotfiles/dirs).

But ultimately this type of repo isn't meant to be used as-is, rather to be a template for others to heavily edit/adapt to their preferences, so by all means move those over to .github if it fits your workflow better! I can see that being the case for some.

Thanks again!

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