diff --git a/docs/organizations/images/coding-standard-strategy.png b/docs/organizations/images/coding-standard-strategy.png new file mode 100644 index 0000000000..e55bc08e3e Binary files /dev/null and b/docs/organizations/images/coding-standard-strategy.png differ diff --git a/docs/organizations/using-coding-standards.md b/docs/organizations/using-coding-standards.md index 310432176f..a283732ea9 100644 --- a/docs/organizations/using-coding-standards.md +++ b/docs/organizations/using-coding-standards.md @@ -165,11 +165,30 @@ Tools and patterns enabled by a coding standard are enforced and cannot be disab ## Using multiple coding standards {: id="using-multiple"} -When Codacy analyzes your code using multiple coding standards, it merges the tools and patterns from each standard. Enabled tools and patterns in any applied standard will be enforced. +When Codacy analyzes your code using multiple coding standards, it merges the tools and patterns from each standard. + +A common strategy is to start with a baseline standard containing fundamental rules that apply across all repositories, then layer additional standards based on specific needs. You can organize these additional standards by: + +- **Topics:** for example, security, performance, or maintainability +- **Architecture:** for example, backend or frontend +- **Languages or frameworks:** for example, React, Java or Python +- **Teams or tribes:** Allow different teams or tribes to maintain their own standards while inheriting organization-wide rules + +![Coding standards strategies](images/coding-standard-strategy.png) + +!!! note + You can apply up to 10 coding standards to your organization. Standards can overlap, meaning a single repository can follow multiple standards simultaneously. !!! important If the same pattern appears in multiple standards, the version from the most recently created and applied standard (with its parameters) takes precedence. +### Implementation guidelines {: id="standards-implementation"} +Consider these points when implementing coding standards: + +- **Keep maintenance simple:** Minimize overlap between standards and establish clear ownership to reduce maintenance complexity +- **Manage access:** Assign organization managers or Git provider admin roles to users who should manage (create, edit and delete) organization-level standards (learn more in [Roles and Permissions](./roles-and-permissions-for-organizations.md/#managing-the-organization-manager-role)) +- **Be mindful of repository customization:** Individual repositories can have their own specific overrides through additional code patterns, custom tool configurations, or local configuration files + ## See also - [Configuring code patterns on each repository](../repositories-configure/configuring-code-patterns.md)