A repository's Issues page lists all of the issues that Code Climate has found in your default branch. Issues are listed in descending order of remediation points, and can be filtered by category, plugin, and/or severity.
Clicking on the link below an issue will take you to the Code page for that file, where you can drill down into the details the individual issue.
In some cases, an issue that Code Climate identifies can benefit from additional manual assessment to validate or invalidate it. For these cases, Code Climate allows developers to mark any issue with one of 3 different statuses (confirmed, invalid, wontfix) as well as restoring the default status (open or new).
If pull request integration is enabled, marking a new issue as invalid or wontfix means the issue will not count toward the Code Climate new issue count on the pull request. Marking an issue as confirmed or new (or leaving the default status of new) means the issue will. This allows developers to exercise their judgment into which issues should fail the Code Climate status of an open pull request.
The full list of statuses and their meanings is below.
|Status||Suggested Meaning||Will fail pull request?|
|Open||This is the default status for existing issues.||N/A|
|New||This is the default status for new issues.||Yes|
|Confirmed||This is a legitimate issue that should be addressed.||Yes|
|Invalid||This issue is a false-positive.||No|
|Wontfix||The issue is legitimate, but it does not need to be addressed at this time.||No|
Adding an issue status works the same way for existing (open) issues as well as new issues. In this example, the pull request workflow is used.
After visiting the pull request page, hovering over an issue title reveals the issue status menu.
Clicking the issue status menu provides the list of available statuses. Here, "Wontfix" is selected.
An optional reason can be provided.
Once created, issue status details can be viewed by hovering over the status label. Details include who made the change, when the change was made, and, if provided, the change reason. In this example, the status of "Wontfix" caused the pull request state to update to "Passed."
Pull Request Approvals
To restrict the ability of certain users to change an Issue's Status, check out our doc on PR Approvals.
By default, each issue is given a severity (info, minor, major, critical, or blocker) describing the potential impact of the issue found. Issues with a severity of INFO will not fail a Pull Request. Issues of any other severity will fail a Pull Request.
Users can override the default severity levels for specific engines. For example, if you'd like to use the FIXME engine, but don't want FIXME issues to fail your pull requests, you can add the following snippet to your
plugins: fixme: enabled: true issue_override: severity: info
FIXME issues will be reported to Code Climate and shown on the pull request page, as well as the issue list, but won't cause your PRs to turn red.
Updated 4 months ago