Introduction to Conformance

Conformance provides tools that run automated checks on your code for product critical issues, such as performance, security, and code health. Conformance runs in the development workflow to help you:

• Prevent issues from being merged into your codebase: Conformance runs locally and on Continuous Integration (CI) to notify developers early and prevent issues from ever reaching production
• Learn from expert guidance directly in your development workflow: Conformance rules were created based on years of experience in large codebases and frontend applications, and with Vercel's deep knowledge of the framework ecosystem
• Burn down existing issues over time: Conformance allowlists enable you to identify and allowlist all existing errors, unblocking development and facilitating gradual error fixing over time. Developers can then incrementally improve the codebase when they have the time to work on the issues. The Vercel dashboard provides access to these errors, allowing you to explore the codebase's health at any time

To get started with Conformance, follow the instructions on the Getting Started page.

Conformance comes with a curated suite of rules that look for common issues. These rules were created based on the decades of combined experience that we have building high quality web applications.

You can lean more about the built-in Conformance rules on the Conformance Rules page.

A core feature in Conformance is the ability to provide allowlists. This mechanism allows organizations to have developers review their conformance violations with an expert on the team before deciding whether it should be allowed. Conformance allowlists can also be added to existing issues, helping to make sure that new code follows the best practices.

Learn more about how this mechanism works on the Allowlists page.

Conformance can be customized to meet your repository's needs. See Customizing Conformance for more information.