diff --git a/docs/manual/developer/04_style_guide.md b/docs/manual/developer/04_style_guide.md index 047d27b26c3..5c0412851e2 100644 --- a/docs/manual/developer/04_style_guide.md +++ b/docs/manual/developer/04_style_guide.md @@ -25,7 +25,7 @@ * Shall remove the sample text from the template pull request * Shall not have merge commits; they should have been taken out by [rebasing](https://docs.github.com/en/get-started/using-git/about-git-rebase) * Should target `master` unless pulling an already merged pull request to a stabilization branch -* Shall have a useful title so that it can used in the changelog +* Shall have a useful title so that it can be used in the changelog ### Before Merging @@ -448,6 +448,13 @@ Instead of: * Must use 4-space indentation * Shall put `do` or `then` on the same line as `for` or `if` respectively, e.g. `for file in *; do` +### GitHub Actions +* Shall follow all the rules in the [YAML](#yaml) section, expect the following: + * Existing files may use the `.yaml` prefix +* Job names should be in [Title case](https://en.wikipedia.org/wiki/Title_case) +* Shall use explicit version numbers for actions + * Updates are handled on a weekly basis by [Dependabot](https://github.com/ComplianceAsCode/content/network/updates) + ### Kubernetes * Shall follow all the rules in the [YAML](#yaml) section @@ -518,7 +525,8 @@ or * Shall use commands, including `if` etc., without extra spaces before or after `(` and `)` (Eg. `command()` * `endif`, `endforeach`, and similar commands shall not have any arguments * Shall keep flowing `)` at same indentation as starting clause -* Shall use no more than 2 empty lines (Eg. 1 empty to mark part and 2 empty to mark sections) +* Shall use no more than 2 empty lines (e.g. 1 empty to mark part and 2 empty to mark sections) +* Shall be written to pass [CMakeLint](https://pypi.org/project/cmakelint/) ## Markup Languages