From 4c45731759814e4d1e8383975871749f6349b294 Mon Sep 17 00:00:00 2001 From: "Kyle J. Davis" Date: Wed, 27 Jul 2022 11:07:06 -0600 Subject: [PATCH 1/2] Docs: adds case convention to CONTRIBUTING Signed-off-by: Kyle J. Davis --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5daf2beb60a..c1f9e7f7fbf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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`). + + ## 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. From 41d77e2dbd590b3958d170e24e45e02c85ecd93a Mon Sep 17 00:00:00 2001 From: "Kyle J. Davis" Date: Wed, 27 Jul 2022 11:11:15 -0600 Subject: [PATCH 2/2] Docs: adds missing comma Signed-off-by: Kyle J. Davis --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c1f9e7f7fbf..eae718f99ba 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -49,7 +49,7 @@ Bottlerocket uses both tags and branches for release alignment. Numbered release Bottlerocket follows a few basic filename case conventions: -- All extensions are lowercase +- 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`).