Extending rules¶
Checklist¶
Extend the RULES list in
wscheck/checker.py
file with the next IDWrite unit tests and production code with TDD
- Extend the
tests/unit/checker/test_rules.py
file with specific unit tests. - Write the checker in
wscheck/checker.py
file. - Extend the complex cases with the new rule related things.
- Extend the
Extend performance tests in
tests/performance/test_checker_performance.py
- With a rule specific suite.
- Extend the complex case too.
- Run all performance tests for check performance degradation!
Extend documentation
- Create
docs/rules/WSC000.rst
file for describing the rule. - Write example into
examples/WSC000_foo
and use it in the.rst
. - Extend
examples/multiple_problems.py
file with a typical wrong line for demonstrate. - Refresh the output in
README.rst
too.
- Create
Update changelog
- Extend the link list of rules at the bottom of
CHANGELOG.md
. - Update the Unreleased section of
CHANGELOG.md
, where refers to the rule.
- Extend the link list of rules at the bottom of