Skip to content

Commit

Permalink
docs: OEP-11 use codecov to measure test coverage
Browse files Browse the repository at this point in the history
  • Loading branch information
brian-smith-tcril committed Aug 22, 2023
1 parent 6d7a3b6 commit 9a4aff3
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 0 deletions.
11 changes: 11 additions & 0 deletions oeps/best-practices/oep-0011-bp-FED-technology.rst
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,16 @@ Technology Selection
There is much desire to replace Mako within edx-platform so this
exception may eventually be removed.

#. **Codecov should be used to measure code covered by tests**

**Rationale**: It is important to measure the amount of code covered by our
automated test suites. By striving for a high level of test coverage, we can
reduce the number of bugs that can only be found via manual testing. another
added benefit comes when we include coverage runs in the CI process, as
contributors are automatically reminded to include tests for any new code.

The Open edX community has standardized around `Codecov`_ as a measurement tool.

Decisions
*********

Expand All @@ -214,6 +224,7 @@ Change History
.. Cross-references
.. _AMD Modules: https://github.com/amdjs/amdjs-api/wiki/AMD
.. _Babel: https://babeljs.io/
.. _Codecov: https://about.codecov.io/
.. _edX ESLint Config: https://github.com/edx/eslint-config-edx/tree/master/packages/eslint-config-edx
.. _edX ESLint Config for ES5: https://github.com/edx/eslint-config-edx/tree/master/packages/eslint-config-edx-es5
.. _edx Frontend Auth Client: https://github.com/edx/frontend-auth
Expand Down
29 changes: 29 additions & 0 deletions oeps/best-practices/oep-0011/decisions/0006-codecov.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
Use Codecov to measure code covered by tests
############################################

Status
******

Accepted

Context
*******

It is important for the health of the Open edX project to measure the amount of code covered by automated testing.

Decision
********

For measuring test coverage, `Codecov`_ should be used.

Consequence
***********

`Codecov`_ has been adopted by the Open edX community as the tool for measuring test coverage.

Rejected Alternatives
*********************

At the time of this decision, no rejected alternatives were documented.

.. _Codecov: https://about.codecov.io/

0 comments on commit 9a4aff3

Please sign in to comment.