diff --git a/.mdl.rb b/.mdl.rb new file mode 100644 index 00000000000..61f127bf0db --- /dev/null +++ b/.mdl.rb @@ -0,0 +1,3 @@ +all +exclude_tag :line_length +rule 'MD007', :indent => 4 diff --git a/.mdlrc b/.mdlrc index 3ae309f9ead..a0d20539982 100644 --- a/.mdlrc +++ b/.mdlrc @@ -1 +1 @@ -tags "~line_length" +style ".mdl.rb" diff --git a/docs/manual/developer/04_style_guide.md b/docs/manual/developer/04_style_guide.md index 2f8a13226b5..84eec6c8832 100644 --- a/docs/manual/developer/04_style_guide.md +++ b/docs/manual/developer/04_style_guide.md @@ -3,22 +3,22 @@ ## Labels * Use labels efficiently - * For example, use only the minimal necessary labels + * For example, use only the minimal necessary labels * Labels must have a clear and objective description * New labels should be created in lowercase * New labels should be agnostic to PRs and Issues * Labels related to the same group/category should share the same colors, like in these examples: - * Assessment languages related labels, like "OVAL" and "OCIL", share the color #0e8a16 - * Attention required labels, like "BLOCKER" and "productization-issue", share the color #e11d21 - * Benchmarks related labels, like "CIS" and "STIG", share the color #08d2d8 - * Components related labels, like "Test Suite" and "Documentation", share the color #84b6eb - * Improvements related labels, like "New Product" or "New Rule", share the color #c2e0c6 - * "EyeCatcher" related labels, like a "Highlight" or "bugfix", share the color #fbca04 - * Product related labels, like "RHEL" and "Ubuntu", share the color #4141f4 - * Remediation related labels, like "Ansible" and "Bash", share the color #9bf442 + * Assessment languages related labels, like "OVAL" and "OCIL", share the color #0e8a16 + * Attention required labels, like "BLOCKER" and "productization-issue", share the color #e11d21 + * Benchmarks related labels, like "CIS" and "STIG", share the color #08d2d8 + * Components related labels, like "Test Suite" and "Documentation", share the color #84b6eb + * Improvements related labels, like "New Product" or "New Rule", share the color #c2e0c6 + * "EyeCatcher" related labels, like a "Highlight" or "bugfix", share the color #fbca04 + * Product related labels, like "RHEL" and "Ubuntu", share the color #4141f4 + * Remediation related labels, like "Ansible" and "Bash", share the color #9bf442 * It is possible to have custom labels for ad-hoc tasks. These must be properly managed and removed when no longer necessary. * Be careful changing labels names or removing labels. Some labels are used by bots and automated processes, like the release changelog generation: - * https://github.com/ComplianceAsCode/content/blob/master/.github/workflows/release-changelog.json + * https://github.com/ComplianceAsCode/content/blob/master/.github/workflows/release-changelog.json ## Pull Requests @@ -88,9 +88,9 @@ and keep these guidelines in mind when writing new code. * Shall use 4-space indentation * Shall have a docstring comment describe what the macro does * Shall have a docstring comment describing all parameters and their types - * Types shall be Python class names. (E.g. `str`, `bool`, `dict`, etc) - * Shall be last section of the docstring - * Shall have one blank after list before the close of the docstring block + * Types shall be Python class names. (E.g. `str`, `bool`, `dict`, etc) + * Shall be last section of the docstring + * Shall have one blank after list before the close of the docstring block * Shall have two blank lines between macros ### Python @@ -265,16 +265,16 @@ Control sections must be in the following order, all sections are required unles * `documentation_complete` * `id` * `metadata` - * `reference` - * `version` - * `SMEs` + * `reference` + * `version` + * `SMEs` * `title` - * Shall be short and descriptive + * Shall be short and descriptive * `description` (HTML-Like) * `extends` (Optional) - * Must be valid id of another profile id + * Must be valid id of another profile id * `selections` - * Must be valid rule ids + * Must be valid rule ids ## Remediation