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.

Sign up for GitHub

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

Jump to bottom

File case convention contrib guide #2306

Merged
merged 2 commits into from
Jul 28, 2022
Merged

File case convention contrib guide #2306

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4c45731
Docs: adds case convention to CONTRIBUTING
stockholmux Jul 27, 2022
41d77e2
Docs: adds missing comma
stockholmux Jul 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,16 @@ Active development occurs under the `develop` branch.

Bottlerocket uses both tags and branches for release alignment. Numbered releases are always associated with [tags that mirror the full SemVer 3-digit version number](https://github.com/bottlerocket-os/bottlerocket/tags) (e.g. `1.7.2`). [Branches are for patching only](https://github.com/bottlerocket-os/bottlerocket/branches/all): if a patch is required, a branch will be cut for that minor release line (e.g. `1.7.x`). As a consequence, some previous minor versions may not have a branch if they never required a subsequent patch.

## Filename case conventions

Bottlerocket follows a few basic filename case conventions:

- All extensions are lowercase,
- Build related configuration files always start with a capital letter (e.g. `Infra.toml`, `Release.toml`),
- 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.

## Finding contributions to work on
Looking at the existing issues is a great way to find something to contribute on.
As this repository uses GitHub issue [labels](https://github.com/bottlerocket-os/bottlerocket/labels), looking at any ['status/helpwelcome'](https://github.com/bottlerocket-os/bottlerocket/labels/status%2Fhelpwelcome) issues is a great place to start.
Expand Down