Extending rules

Checklist

  1. Extend the RULES list in wscheck/checker.py file with the next ID

  2. Write unit tests and production code with TDD

    1. Extend the tests/unit/checker/test_rules.py file with specific unit tests.
    2. Write the checker in wscheck/checker.py file.
    3. Extend the complex cases with the new rule related things.

  3. Extend performance tests in tests/performance/test_checker_performance.py

    1. With a rule specific suite.
    2. Extend the complex case too.
    3. Run all performance tests for check performance degradation!

  4. Extend documentation

    1. Create docs/rules/WSC000.rst file for describing the rule.
    2. Write example into examples/WSC000_foo and use it in the .rst.
    3. Extend examples/multiple_problems.py file with a typical wrong line for demonstrate.
    4. Refresh the output in README.rst too.

  5. Update changelog

    1. Extend the link list of rules at the bottom of CHANGELOG.md.
    2. Update the Unreleased section of CHANGELOG.md, where refers to the rule.