themehybrid / hybrid-core

Official repository for the Hybrid Core WordPress development framework.
GNU General Public License v2.0
687 stars 143 forks source link

Use consistent naming across project #175

Closed justintadlock closed 4 days ago

justintadlock commented 3 years ago

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.

szepeviktor commented 1 year ago

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.