Skip to content

Latest commit

 

History

History
38 lines (21 loc) · 1.91 KB

CONTRIBUTING.md

File metadata and controls

38 lines (21 loc) · 1.91 KB

How to contribute to bdg-formats

Thank you in advance for contributing to bdg-formats!

It would be great if you could introduce yourself to the community on one of the following channels but it is not required. You can just let your code do the talking for you if you like.

Join the ADAM Gitter channel

As an upstream dependency of ADAM, the primary mechanism for communication between bdg-formats developers and users is the ADAM Gitter channel.

Join the ADAM IRC channel

If you prefer IRC, you can often find bdg-formats developers and users on Freenode IRC in the #adamdev room.

Join the ADAM developers mailing list

The ADAM project also hosts a developers mailing list, which can be used to discuss bdg-formats, see http://bdgenomics.org/mail/ for details.

Search the Github issue tracker and pull requests

Before you write too much code, check the open issues in the bdg-formats issue tracker and bdg-formats open pull requests to see if someone else is already working on it. If the issue is a new one, and you have already written the code to address the issue, simply submit a pull request. If you haven't written any code but plan to, go ahead and open a new issue and assign it to yourself to socialize your work. When you submit your PR, please reference this pull request so that it will be automatically closed when the PR is merged.

Submit your pull request

Github provides a nice overview on how to create a pull request.

We appreciate your contribution!