docbrown/docs/tests/codeclimate.md
Andy Zhao 955bdcb2bc
Update docs with Forem instead of dev.to (#9316)
* Rename all GitHub links from thepracticaldev/dev.to to forem/forem

* Use new site name

* Rename to Forem

* Rename more dev.to to forem

* Remove unnecessary redirects

* Rename DEV to Forem

* Use Forem instead of DEV for branding

* Use Forem instead of DEV for licensing

* Use seedling instead of DEV logo
2020-07-15 13:29:11 -04:00

27 lines
1.1 KiB
Markdown

---
title: Code Climate
---
# Code Climate
We are using [Code Climate](https://codeclimate.com/github/forem/forem) to track
code quality and coverage.
Code Climate offers metrics regarding code quality for each individual PR,
however, it does not calculate these metrics for the entirety of the project. If
you'd like update the current linting rule, feel free to submit a PR to change
it.
Before merging a PR to Forem, we expected Code Climate to pass on that PR. If
you find Code Climate raising errors on your PR, please fix those issues. Do
your best to leave code in a better state than you found it!
We don't want to make a habit of pandering to Code Climate and its metrics
blindly, so if you're in doubt regarding a suggestion on your PR please start a
conversation in the PR comments.
Generally speaking, if you're looking for opportunities to contribute to the
project, but you don't have an issue you're interested in solving. Improving the
Code Climate metrics is a good place to start. We're happy to see PRs that
refactor existing code to reduce duplication and increase readability, given
that those refactors are well tested.