Skip to content

Commit 86e9379

Browse files
Adding "coding standard strategies" to standards page (#2330)
* update standards file * add image + paragraph on strategies * update image * update according to feedback * Update docs/organizations/using-coding-standards.md
1 parent 896cdbb commit 86e9379

File tree

2 files changed

+20
-1
lines changed

2 files changed

+20
-1
lines changed
158 KB
Loading

docs/organizations/using-coding-standards.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,11 +165,30 @@ Tools and patterns enabled by a coding standard are enforced and cannot be disab
165165

166166
## Using multiple coding standards {: id="using-multiple"}
167167

168-
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.
168+
When Codacy analyzes your code using multiple coding standards, it merges the tools and patterns from each standard.
169+
170+
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:
171+
172+
- **Topics:** for example, security, performance, or maintainability
173+
- **Architecture:** for example, backend or frontend
174+
- **Languages or frameworks:** for example, React, Java or Python
175+
- **Teams or tribes:** Allow different teams or tribes to maintain their own standards while inheriting organization-wide rules
176+
177+
![Coding standards strategies](images/coding-standard-strategy.png)
178+
179+
!!! note
180+
You can apply up to 10 coding standards to your organization. Standards can overlap, meaning a single repository can follow multiple standards simultaneously.
169181

170182
!!! important
171183
If the same pattern appears in multiple standards, the version from the most recently created and applied standard (with its parameters) takes precedence.
172184

185+
### Implementation guidelines {: id="standards-implementation"}
186+
Consider these points when implementing coding standards:
187+
188+
- **Keep maintenance simple:** Minimize overlap between standards and establish clear ownership to reduce maintenance complexity
189+
- **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))
190+
- **Be mindful of repository customization:** Individual repositories can have their own specific overrides through additional code patterns, custom tool configurations, or local configuration files
191+
173192
## See also
174193

175194
- [Configuring code patterns on each repository](../repositories-configure/configuring-code-patterns.md)

0 commit comments

Comments
 (0)