Skip to content

Using a coding standard#

This is a beta feature

This is a new Codacy feature and we're working to release the following improvements soon:

  • Deleting and renaming a coding standard
  • Applying a coding standard by default to new repositories

For more information read the release announcement or watch a demo (3 min) to learn how to create a coding standard for your organization.

Create a coding standard on your organization to define and apply shared tool and code pattern configurations consistently across your repositories.

The organization coding standard helps you ensure that Codacy analyzes multiple repositories with the same tool and code pattern settings. For example, you can use the organization coding standard to ensure that all your repositories and teams are following the same security rules or coding conventions.

When you customize the tools or code patterns of a repository that follows the coding standard, Codacy warns you that the repository will stop following the coding standard and asks for your confirmation.

Creating a coding standard#

To create a coding standard for your organization:

  1. Open your organization Coding standards page, tab Coding standards.

  2. Name your coding standard and click Create standard.

    Optionally, select a repository that Codacy will use as a baseline to bootstrap the tool and pattern configurations for the new coding standard. This is useful if you already have a repository with code patterns configured that you wish to use as a template for creating the coding standard.

    Creating a new coding standard

  3. Select all the programming languages that the new coding standard will cover and click Next: Tools and patterns.

    The coding standard will only include configurations for the tools that support at least one of the selected languages.

    Selecting the languages for the coding standard

  4. Configure the tools and patterns of the coding standard and click Next: Select and apply to repositories.

    • Toggle the tools that Codacy will run when analyzing your code
    • For each enabled tool, configure the code patterns that the tool will use

    You can use the filters to help you find the relevant tools and code patterns. The recommended configurations are manually curated by Codacy or based on the default code patterns of the tools and are marked with the icon Recommended icon.

    Configuring the tools and patterns for the coding standard

  5. Select existing repositories that should follow the new coding standard and click Save and apply standard.

    Important

    Saving and applying a coding standard overwrites the existing tool and code pattern configurations on the selected repositories for all tools included in the coding standard.

    Codacy will start using the new coding standard on the next analysis of each selected repository.

    Applying the coding standard to repositories

Editing a coding standard#

To edit an existing coding standard or change the repositories that follow that coding standard:

  1. Open your organization Coding standards page, tab Coding standards.

  2. Click the edit icon on the coding standard card.

    Editing an existing coding standard

  3. Make your changes to the current coding standard configurations and click the button Next to advance between the following pages:

    • The programming languages that the coding standard applies to
    • The tool and code pattern configurations of the coding standard
    • The repositories that follow the coding standard
  4. Click the button Save and apply standard on the repository selection page to save your changes to the coding standard.

    Important

    Saving and applying a coding standard overwrites the existing tool and code pattern configurations on the selected repositories for all tools included in the coding standard.

    Codacy will start using the updated coding standard on the next analysis of each selected repository.

See also#

Share your feedback 📢

Did this page help you?

Thanks for the feedback! Is there anything else you'd like to tell us about this page?

We're sorry to hear that. Please let us know what we can improve:

Alternatively, you can create a more detailed issue on our GitHub repository.

Thanks for helping improve the Codacy documentation.

If you have a question or need help, please ask our community or contact support@codacy.com.

Last modified December 2, 2021