Code Inspector Documentation

Code Inspector Documentation

  • Getting Started
  • Integration
  • API
  • FAQ

›Getting Started

Getting Started

  • Getting Started
  • Create Account
  • Create Group
  • Create Project
  • Add a Badge
  • Automated Codefix

Metrics and Dashboard

  • List of Metrics
  • Analysis Results
  • Project Dashboard
  • Technical Debt Estimates
  • Dependencies

Configuration

  • Project preferences
  • Ignore Files and Violations
  • Branch Support

Pricing and Billing

  • Pricing
  • Billing

Add a Badge

You can show a badge on your project page to show the code grade (as shown below).

Example of badge

The video below shows how to add a badge to your repository.

Show the Code Quality Score

The Code Quality Score is a value from 0 to 100 that reflects the quality of your code base.

Insert the following code snippet in the README.md file at your project root (replace <PROJECT_IDENTIFIER> with the project identifier).

[![Code Grade](https://www.code-inspector.com/project/<PROJECT_IDENTIFIER>/score/svg)](https://www.code-inspector.com)

Hint: you can find the full URL to use in your project preferences.

Show the Code Grade

The code grade is a note from A (best quality) to F (worst quality) for your code base.

Insert the following code snippet in the README.md file at your project root (replace <PROJECT_IDENTIFIER> with the project identifier).

[![Code Grade](https://www.code-inspector.com/project/<PROJECT_IDENTIFIER>/status/svg)](https://www.code-inspector.com)

Hint: you can find the full URL to use in your project preferences.

← Create ProjectAutomated Codefix →
  • Show the Code Quality Score
  • Show the Code Grade
Code Inspector Documentation
Docs
Getting StartedIntegrationsAPI Reference
Community
SlackTwitter
More
Medium
Follow @code_inspector
Copyright © 2021 XCoding labs, LLC