Skip to content

Latest commit

 

History

History
71 lines (62 loc) · 3.15 KB

CONTRIBUTING.md

File metadata and controls

71 lines (62 loc) · 3.15 KB
Raw

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Code Style

Please adhere to PEP8 style guidelines unless called out in this document.

  1. Add 3 lines of whitespace between classes and free functions.
  2. Prefer 2 lines of whitespace between methods within classes.
  3. Prefer all methods in classes should have an explicit return statement.
  4. All pytest tests shoud return 0 if the test is successful.
  5. Conform to Google-style docstrings except for where it might break Sphinx formatting.
  6. Lines should not exceed 120 columns except in cases where it reduces the readability of the code.

Auto-formatting

We can also use the YAPF tool to perform auto-formatting. The .style.yapf file provides a formatting scheme that is also good. Using this breaks (2) above, it will only add 1 line between method definitions so this should be adjusted manually.

Versioning

This project uses Semantic Versioning.

Merge Request Process

  1. Ensure any unapproved install or build dependencies are removed before submitting a merge request.
  2. Update the CHANGELOG.md file with details of the changes you are making.
  3. Update relevant documentation in the doc/ folder and any appropriate docstrings.
  4. Update unit tests to fully test your additions. We aim for 100% coverage on this project.
  5. Ensure unit tests and documentation build cleanly by running exec-tests.sh, exec-makedoc.sh and the example applications in the repository.
  6. Run the exec-reformat.py script in the repository's root directory to update all formatting using the YAPF tool. This is optional but STRONGLY encouraged, we reserve the right to reject a merge request if this hasn't been run.

Code of Conduct

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

Standards

Examples of behavior that contributes to creating a positive environment include:

  • Using welcoming and inclusive language
  • Being respectful of differing viewpoints and experiences
  • Gracefully accepting constructive criticism
  • Focusing on what is best for the community
  • Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

  • The use of sexualized language or imagery and unwelcome sexual attention or advances
  • Trolling, insulting/derogatory comments, and personal or political attacks
  • Public or private harassment
  • Publishing others' private information, such as a physical or electronic address, without explicit permission
  • Other conduct which could reasonably be considered inappropriate in a professional setting