Skip to content

Commit da007f7

Browse files
committed
ci(coverage): updating CONTRIBUTING to reflect CI constraints (#239)
1 parent 4ec27a1 commit da007f7

2 files changed

Lines changed: 15 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,15 @@ developing features or fixing bugs yourself.
1919
* If you are interested in contributing code, fork the repository, create a
2020
branch, and open a pull request.
2121

22+
## Code quality and testing
23+
24+
In order to maintain a certain standard regarding code quality, this repository CI will run various tools against expectations:
25+
- `isort` will be used to check for proper imports sorting, and the CI will fail if the checks fail
26+
- `black` will be used to check for proper code formatting, and the CI will fail if the checks fail
27+
- `flake8` will be used to check for proper code styling, and the CI will fail if the checks fail
28+
- `pytest` will be used to run various levels of testing, and the CI will fail if the tests fail
29+
- `coverage` with `codecov` will be used to check for proper code coverage, and the CI will fail if the level is below 80% for the current diff (a warning will be emitted if the level falls below 80% for the overall project)
30+
2231
<!-- filigran-conventions:start -->
2332
## Commit, pull request & issue conventions
2433

test/daemons/test_base_daemon.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,9 @@ def test_when_no_callback_when_lacking_config_key_ctor_throws(self, _):
6363
DaemonForTest(configuration=Configuration(config_hints={}))
6464

6565
def test_when_no_callback_daemon_cant_start(self, m_argparser):
66-
m_argparser.return_value.parse_args.return_value = unittest.mock.MagicMock(dump_config_schema=False)
66+
m_argparser.return_value.parse_args.return_value = unittest.mock.MagicMock(
67+
dump_config_schema=False
68+
)
6769
daemon, mock_setup, mock_start_loop, _ = create_mock_daemon()
6870

6971
with self.assertRaises(OpenAEVError):
@@ -73,7 +75,9 @@ def test_when_no_callback_daemon_cant_start(self, m_argparser):
7375
mock_start_loop.assert_not_called()
7476

7577
def test_when_callback_daemon_can_start(self, m_argparser):
76-
m_argparser.return_value.parse_args.return_value = unittest.mock.MagicMock(dump_config_schema=False)
78+
m_argparser.return_value.parse_args.return_value = unittest.mock.MagicMock(
79+
dump_config_schema=False
80+
)
7781
daemon, mock_setup, mock_start_loop, _ = create_mock_daemon(lambda: None)
7882

7983
daemon.start()

0 commit comments

Comments
 (0)