Repository navigation
Move the .README under .github folder #1
Description
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
Activity
fperez commentedon 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
$HOMEunder version control itself separately. That's not a wise thing to do if you stuff everything, but someone could control$HOMEwith a suitable.gitignorethat's very curated, and thus have a legit need for.githubnot to be overwritten.Instead, I chose to put the minimal amount of clutter here:
.READMEand.LICENSEand 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
.githubif it fits your workflow better! I can see that being the case for some.Thanks again!