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

File case convention contrib guide #2306

Merged

Conversation

stockholmux
Copy link
Member

Signed-off-by: Kyle J. Davis [email protected]

Issue number: N/a

Description of changes: Adds note to the contributing guide that outlines how filenames should be capitalized or not.

Testing done: Eyeballs.

Terms of contribution:

By submitting this pull request, I agree that this contribution is dual-licensed under the terms of both the Apache License, version 2.0, and the MIT license.

Copy link
Contributor

@stmcginnis stmcginnis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great to get this written down!

- All caps is used for documents and licenses (e.g. `PUBLISHING.md`, `TRADEMARKS.md`),
- All lower case is used for all other files (e.g. `sample-eksctl.yaml`, `main.rs`).


Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just pointing out a nit, but if we enable markdown linting it will complain about an extra newline here. That said, if and when we do enable that, there will be plenty of other things to clean up, so this really doesn't matter.

@stmcginnis stmcginnis merged commit d6c2b77 into bottlerocket-os:develop Jul 28, 2022
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

Successfully merging this pull request may close these issues.

3 participants