Skip to content

Latest commit

 

History

History
63 lines (40 loc) · 2.51 KB

CONTRIBUTING.md

File metadata and controls

63 lines (40 loc) · 2.51 KB
Raw

Contributor Guide

Thank you for your interest in improving this project. This project is open-source under the MIT license and welcomes contributions in the form of bug reports, feature requests, and pull requests.

Here is a list of important resources for contributors:

How to report a bug

Report bugs on the Issue Tracker.

When filing an issue, make sure to answer these questions:

  • Which operating system and Python version are you using?
  • Which version of this project are you using?
  • What did you do?
  • What did you expect to see?
  • What did you see instead?

The best way to get your bug fixed is to provide a test case, and/or steps to reproduce the issue.

How to request a feature

Request features on the Issue Tracker.

How to set up your development environment

This project use a Visual Studio Code Dev Container. This approach will create a preconfigured development environment with all the tools you need.

How to test the project

Unit tests are located in the tests directory, and are written using the pytest testing framework. Run the full test suite:

$ pytest tests

There is also a Visual Studio Code task available to run the full test suite or you can use the testing feature from Visual Studio Code.

How to submit changes

Open a pull request to submit changes to this project.

Your pull request needs to meet the following guidelines for acceptance:

  • The test suite must pass without errors and warnings.
  • Include unit tests. This project maintains 100% code coverage.
  • If your changes add functionality, update the documentation accordingly.

Feel free to submit early, though—we can always iterate on this.

To run linting and code formatting checks before commiting your change, pre-commit as a Git hook is installed within the Visual Studio Code Dev Container.

It is recommended to open an issue before starting work on anything. This will allow a chance to talk it over with the owners and validate your approach.