You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This has bothered me for a while. I like to keep this directory as pristine as possible, and this file looks out of context. It is not documentation one needs to see on first glance of the project, and we don't otherwise have any convention of putting docs into the root dir.
One easy change would be to put this file in src/test, though it's unlikely to be discovered there (which is a problem probably with a number of such documents in the tree). I'd prefer that to having this single document out of place in the root.
The text was updated successfully, but these errors were encountered:
brson
added
A-docs
E-easy
Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.
labels
Feb 17, 2017
This has bothered me for a while. I like to keep this directory as pristine as possible, and this file looks out of context. It is not documentation one needs to see on first glance of the project, and we don't otherwise have any convention of putting docs into the root dir.
One easy change would be to put this file in src/test, though it's unlikely to be discovered there (which is a problem probably with a number of such documents in the tree). I'd prefer that to having this single document out of place in the root.
The text was updated successfully, but these errors were encountered: