Skip to content

Latest commit

 

History

History
67 lines (42 loc) · 2.2 KB

CONTRIBUTING.md

File metadata and controls

67 lines (42 loc) · 2.2 KB

Contributing to GraphBin project

We love to have your contributions to the GraphBin project, whether it's:

  • Reporting a bug
  • Submitting a fix
  • Proposing new features

Clone and install GraphBin onto your machine

First, make sure you have git installed on your machine.

On GitHub, fork the GraphBin repository and clone it to your machine.

# clone repository to your local machine
git clone https://github.com/metagentools/GraphBin.git

Move to the GraphBin directory and install GraphBin via flit.

# go to repo direcotry
cd GraphBin

# install flit
pip install flit

# install graphbin via flit
flit install -s --python `which python`

Test GraphBin installation

Use the following command to run pytest and the all the tests should pass.

pytest

Coding Style

We adhere to the PEP 8 style guide.

Before committing, make sure to run black and isort.

Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue in GitHub issues. You will get to select between templates for bug report and feature request.

Committing code

Once you have finished coding and all the tests pass, commit your code and make a pull request. Make sure to follow the commit style of c3dev.

git commit -m "<commit message>"
git push

Your contribution will be reviewed before accepting it.

License

By contributing, you agree that your contributions will be licensed under the BSD-3 License.

References

This document was adapted from the open-source contribution guidelines for Transcriptase and c3dev.