7d0aeeefe5
* Improve format and clarity of the docs [ci skip] While this change produces a lot of git noise by enacting what seems like an arbitrary linewrap on most of the files in the documentation it will result in better version control and tracking of the changes in the documentation. For example, as it currently stands, if one was to make a PR to move a comma in a sentence because each paragraph in most of the files is on a single line, that small change would look in the git history like the author had modified the entire paragraph. In reality, this author just moved a comma. This change also includes a significant number of modifications to the more article-esque docs. Many of these docs were written in a sort of stream-of-conciousness and aren't as easy to read as they could be. Hopefully this is the first of several readability changes. If we could get these docs to a more accessible reading level, we would probably see an increase in contributions. :) * Delegate markdown wrapping to Prettier * Add linewrapping explanation in the docs [ci skip]
1.1 KiB
| title |
|---|
| Code Climate |
Code Climate
We are using Code Climate 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 DEV, 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.