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

Remove readme files? #5

Open
izahn opened this issue Aug 7, 2019 · 1 comment
Open

Remove readme files? #5

izahn opened this issue Aug 7, 2019 · 1 comment

Comments

@izahn
Copy link

izahn commented Aug 7, 2019

I notice that as we use this template we usually don't bother to update all the readme files. This creates two problems: it misleads people into thinking we have something to tell them (else why would we have a readme? and it clutters up commit histories. We could eliminate the second problem by keeping files but removing all content from them, but we would still have the first problem (readme's that don't actually need to be read because they just contain uninformative boilerplate).

Proposal: remove all readme files except for the one in the top level. Thoughts @mbsabath ?

@mbsabath
Copy link
Contributor

mbsabath commented Aug 7, 2019

I think that makes sense. Maybe we can take the language from the internal readmes in to the top level one.

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