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

Use consistent naming across project #175

Open
justintadlock opened this issue Mar 8, 2021 · 1 comment
Open

Use consistent naming across project #175

justintadlock opened this issue Mar 8, 2021 · 1 comment
Assignees
Milestone

Comments

@justintadlock
Copy link
Member

Just a quick thing I noticed with some of the new repos. LICENSE and README.md should be named license.md and readme.md for consistency.

@saas786 saas786 self-assigned this Mar 9, 2021
@saas786 saas786 added this to the 6.0.0 milestone Mar 11, 2021
@szepeviktor
Copy link

szepeviktor commented Jan 29, 2023

There are 3 things to consider in the root directory of a package.

  1. keep only configuration files and DOCUMENTATION in the root directory
  2. name configuration files with lowercase letters (these are for machines)
  3. name DOCUMENTS with uppercase letters (these are for humans)
  4. use as few dot .files as you can (e.g. ls commands hides dot files by default)

So your root will be clean, and you can differentiate configuration files from documents at a glance.

saas786 added a commit to saas786/hybrid-attr that referenced this issue Feb 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants