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

proposal: non-all-uppercase filenames #18

Closed
tfiers opened this issue Apr 14, 2022 · 3 comments
Closed

proposal: non-all-uppercase filenames #18

tfiers opened this issue Apr 14, 2022 · 3 comments
Labels
enhancement New feature or request

Comments

@tfiers
Copy link
Contributor

tfiers commented Apr 14, 2022

total bikeshed:

Current Situation

markdown filenames are in all caps (CODE_OF_CONDUCT.md, LICENSE.md, README.md, CONTRIBUTING.md, ..)

Enhancement

PascalCase (if readable) or upper Kebab-Case: Code-of-Conduct.md, License.md, ReadMe.md, Contributing.md, ..

Reasoning

Friendlier vibes.
I want computing to be cosy.
GitHub recognizes these just as well (e.g. for the "About" links on a repo's home page): https://github.com/tfiers/gh-behaviour-testing
GitHub does the same thing. (This is from another place where these files are linked: starting a new discussion thread:)
image

@tfiers tfiers added the enhancement New feature or request label Apr 14, 2022
@thesamovar
Copy link
Contributor

I'm fine with this.

@rorybyrne
Copy link
Contributor

I won't die on this hill, but I personally find it useful to "filter out" any filenames with ALL_CAPS, because I know they are not related to code. Makes it easier to parse the project IMO. There's also something to be said for following conventions, but it's not so important in this case.

If my "filtering" argument hasn't convinced you, then I'm also OK with switching!

@thesamovar
Copy link
Contributor

Again I'm going to say let's just leave it as it is and close this issue. What we have is fine! OK?

@tfiers tfiers closed this as completed May 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants