Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding "coding standard structures" to standards page #2330

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Adding "coding standard structures" to standards page #2330

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
00f1b0b
update standards file
claudiacodacy Jan 30, 2025
ecfa574
Merge branch 'master' into add-coding-standard-framework
claudiacodacy Jan 30, 2025
1a9cc45
add image + paragraph on strategies
claudiacodacy Feb 3, 2025
40fd37f
Merge branch 'add-coding-standard-framework' of https://github.com/co…
claudiacodacy Feb 3, 2025
959d021
update image
claudiacodacy Feb 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/organizations/images/coding-standard-strategy.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 15 additions & 1 deletion docs/organizations/using-coding-standards.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,11 +165,25 @@

## 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, frontend, APIs

Check failure on line 173 in docs/organizations/using-coding-standards.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'APIs'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'APIs'?", "location": {"path": "docs/organizations/using-coding-standards.md", "range": {"start": {"line": 173, "column": 53}}}, "severity": "ERROR"}
- **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.

Individual repositories can have their own specific overrides on top of the applied coding standards 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)
Expand Down
Loading