Skip to content

Latest commit

 

History

History
22 lines (15 loc) · 894 Bytes

contributing.md

File metadata and controls

22 lines (15 loc) · 894 Bytes

Contributing to pyClarion

Thank you for your interest in contributing to pyClarion!

General Instructions

Please use Github issues for all communications, including bug reports, feature requests, and general questions.

Before working on a new feature, please open an issue to discuss it with project maintainers to make sure it is appropriate.

When submitting a pull request, please make sure the following criteria are fulfilled.

  • Target issues are referenced in the description
  • Significant changes are reported in the changelog

Coding Conventions

  • Follow PEP 8 coding style
  • Include type annotations
  • Use reStructuredText for markup in docstrings (keep it light)
  • When practical, explicitly express preconditions, postconditions, invariants etc. using exceptions and assertions
  • Avoid dependencies outside of Python stdlib
  • Focus testing on functional requirements