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

docs: update with cross tool search and issues / kloc #2252

Merged
merged 1 commit into from
Nov 4, 2024
Merged

docs: update with cross tool search and issues / kloc #2252

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions docs/faq/code-analysis/which-metrics-does-codacy-calculate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Codacy calculates the number of issues in the following static code analysis cat
- **Comprehensibility:** Code that can be difficult to understand and modify
<!--issue-categories-end-->

Besides this, Codacy also allows you to compare issues across repositories with different sizes by calculating the issue cost **relative to a baseline of 1 point per line of code**, where the cost of each issue depends on its severity: Critical = 10 points, Medium = 5 points, Minor = 1 point. This means that if your repository has 50% issues, the amount and severity of the issues in your repository is half of the baseline.
Besides this, Codacy also allows you to compare issues across repositories with different sizes by showing **issues per thousand lines of code (kLoC)**.

Codacy displays issues on the following places:

Expand All @@ -70,9 +70,9 @@ Codacy displays issues on the following places:
|[Commit detail page](../../repositories/commits.md)<br/>[Pull request detail page](../../repositories/pull-requests.md)<br/>[Email notifications](../../account/emails.md#managing-your-email-notifications)|Number of new and fixed issues introduced by the commit or pull request|
|[Files page](../../repositories/files.md)|Number of issues in each file|
|[Issues page](../../repositories/issues.md)|List of all issues detected in each branch|
|[Repository Dashboard](../../repositories/repository-dashboard.md)|Issue percentage and how the metric is evolving over time|
|[Organization overview](../../organizations/organization-overview.md)|Average issue percentage of the repositories in your organization and issue percentage of each repository|
|[Repositories list page](../../organizations/managing-repositories.md)|Issue percentage in each repository in your organization|
|[Repository Dashboard](../../repositories/repository-dashboard.md)|Issues per 1000 lines of code|
|[Organization overview](../../organizations/organization-overview.md)|Average issues / kLoC of the repositories in your organization and issue / kLoC of each repository|
|[Repositories list page](../../organizations/managing-repositories.md)|Issues / kLoC in each repository in your organization|

## Complexity

Expand Down
1 change: 1 addition & 0 deletions docs/organizations/using-coding-standards.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ If you selected **Advanced setup** when [creating a new coding standard](#creati

- Toggle the tools to run when Codacy analyzes your code.
- For each enabled tool, configure the code patterns to use.
- You can also use the **Discover patterns** option to find patterns across all tools.

!!! tip
- Use the filters to find the relevant tools and code patterns. The recommended configurations are manually curated by Codacy or based on tool defaults and are marked with the icon ![Recommended icon](images/coding-standard-recommended-icon.png).
Expand Down
9 changes: 9 additions & 0 deletions docs/repositories-configure/configuring-code-patterns.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
By default, Codacy analyzes your repositories using a subset of the supported analysis tools and code patterns. These defaults are based on current best practices and community feedback, and you can adapt them to your needs as follows:

- [Configuring tools and code patterns using the Codacy UI](#configuring-tools-and-code-patterns-using-the-codacy-ui)
- [Discover code patterns across all tools](#discover-code-patterns-across-all-tools)
- [Customizing applied coding standards](#using-your-own-tool-configuration-files)
- [Customizing patterns when following coding standards](#customizing-patterns-following-standards)
- [Using tool configuration files](#using-your-own-tool-configuration-files)
Expand Down Expand Up @@ -38,6 +39,14 @@

1. Optionally, to take the changes into account immediately, [reanalyze the repository manually](../faq/repositories/how-do-i-reanalyze-my-repository.md). Otherwise, Codacy will use the updated configuration when analyzing new commits and pull requests.

## Discover code patterns across all tools {: id="discover-code-patterns-across-all-tools"}

To discover code patterns across all tools, click **Discover patterns** at the top of the **Tools** list.

Use the input field to search for patterns by name or description. You can also filter by severity level, issue category, recommended or disabled patterns.

Check warning on line 46 in docs/repositories-configure/configuring-code-patterns.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.OxfordComma] Use the Oxford comma in 'You can also filter by severity level, issue category, recommended or'.

Raw Output:
{"message": "[Microsoft.OxfordComma] Use the Oxford comma in 'You can also filter by severity level, issue category, recommended or'.", "location": {"path": "docs/repositories-configure/configuring-code-patterns.md", "range": {"start": {"line": 46, "column": 68}}}, "severity": "WARNING"}

You can also expand your search to include patterns from all tools, even if the tool is not enabled for the repository.

Check failure on line 48 in docs/repositories-configure/configuring-code-patterns.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'isn't' instead of 'is not'.

Raw Output:
{"message": "[Microsoft.Contractions] Use 'isn't' instead of 'is not'.", "location": {"path": "docs/repositories-configure/configuring-code-patterns.md", "range": {"start": {"line": 48, "column": 86}}}, "severity": "ERROR"}

## Customizing applied coding standards {: id="customizing-applied-coding-standards"}

To apply or edit a repository's [coding standards](../organizations/using-coding-standards.md), click **Customize** in the **Following ...** section at the top of the **Code patterns** page.
Expand Down
Loading