Skip to content

Resolve "Update contribution guide with steps for a merge request"

Merge request check list

This is just a reminder about the most common mistakes. Please make sure that you tick all appropriate boxes. But please read our contribution guide at least once, it will save you unnecessary review cycles !

If an item doesn't apply to your merge request, check it anyway to make it apparent that there's nothing to do.

  • Closes issue #428 (closed)
  • Added tests for change code
  • Updated documentation for changed code
  • Documentation .rst files is written using semantic newlines
  • User visible changes (including notable bug fixes and possible deprecations) are documented in CHANGELOG.md
  • Passes in this order
    • isort . or pre-commit run -a (preferred way)
    • black . or pre-commit run -a (preferred way)
    • blackdoc . or pre-commit run -a (preferred way)
    • mypy . or tox -e mypy or tox -p (preferred way)
    • flake8 . or tox -e flake8 or tox -p (preferred way)

If you have any questions of the points above, just submit and ask! This checklist is here to help you, not to deter you from contributing !

Edited by Frederic Lemmel

Merge request reports

Loading