Code Coverage docs

This commit is contained in:
Francisco Gindre 2021-09-10 11:35:10 -03:00
parent 00324a5afe
commit 151979388f
4 changed files with 15 additions and 0 deletions

View File

@ -17,5 +17,6 @@ This code review checklist is intended to serve as a starting point for the auth
- [ ] Ad hoc review: Did you perform an ad hoc review? _In addition to a first pass using the code review guidelines, do a second pass using your best judgement and experience which may identify additional questions or comments. Research shows that code review is most effective when done in multiple passes, where reviewers look for different things through each pass._
- [ ] Automated tests: Did you review the automated tests?
- [ ] Manual tests: Did you review the manual tests?
- [ ] How is Code Coverage affected by this PR? _We encourage you to compare coverage befor and after your changes and when possible, leave it in a better place. [Learn More...](../blob/master/docs/testing/local_coverage.md)_
- [ ] Documentation: Did you review Docs, [README.md](../blob/master/README.md), [LICENSE.md](../blob/master/LICENSE.md), and [Architecture.md](../blob/master/docs/Architecture.md) as appropriate?
- [ ] Run the app: Did you run the app and try the changes? While the CI server runs the app to look for build failures or crashes, humans running the app are more likely to notice unexpected log messages, UI inconsistencies, or bad output data.

View File

@ -0,0 +1,14 @@
# Gathering Code Coverage
Although full coverage it's not our finality, we use this metric as a way to be aware of which code is being tested and to what extent.
## Checking the coverage locally
Once you run the tests locally you should be able to see the tests by going to the logs pane of the project navigation panel under the coverage section for that build run.
![](../../screens/locating_coverage.png)
## Coverage results
Our advice is that you run coverage before and after implementing a feature, so that you can assess how the code and tests you developed affected coverage.
![](../../screens/coverage_percent.png)

Binary file not shown.

After

Width:  |  Height:  |  Size: 87 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 106 KiB