Skip to content

Latest commit

 

History

History
20 lines (11 loc) · 970 Bytes

contributing.md

File metadata and controls

20 lines (11 loc) · 970 Bytes

Contributing to PairProphet

Thanks for taking the time to contribute to PairProphet! Before you get started, please read the code of conduct. For this project, when reporting a bug fix or feature request, please file an issue on GitHub. If you would like to contribute code, please fork the repository and submit a pull request. We will review the pull request and merge it if it is approved.

Getting Started

TODO: Add instructions for setting up the development environment. For now, see the README for instructions on how to install the package.

TODO: Note that user has to download FATCAT at the current version.

Running the tests

Test are written as usual Python unit tests with unittest module. To run the tests, run python -m unittest discover from the root directory of the repository.

Coding guidelines

This project targets Python 3.9 or later.

TODO: add exposition on coding style of the project.