CONTRIBUTING.rst
Contributing
============
.. IMPORTANT::
First off, thanks for taking the time to contribute!
The following is a set of guidelines for contributing to BEL.bio and its
repositories, which are hosted in `BELbio <https://github.com/belbio>`__
on GitHub. These are mostly guidelines, not rules. Use your best
judgment, and feel free to propose changes to this document in a pull
request. If you have any questions, please let us know.
You will need to sign a Contributer's License Agreement (CLA) the first time you submit a pull request and anytime afterwards that the CLA agreement is updated (very rarely). This is signed by clicking on the request as part of the pull request and digitally signed with your Github ID automatically.
Code of Conduct
---------------
This project and everyone participating in it is governed by the *Code
of Conduct* :doc:`link_conduct`. By participating, you are expected to uphold
this code. Please report unacceptable behavior to one of the project
maintainers, `William Hayes <mailto:whayes@adsworks.com>`__ or `Anselmo
Di Fabio <mailto:adifabio@adsworks.com>`__.
Code Contributions
------------------
This project uses the Git Forking workflow as discussed here
https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow
.. TIP::
It may be helpful to review your plans with the community before starting work.
1. Please add an issue to the repository prior to working on a feature
or bug.
2. Fork and clone the repository
3. Create a topic branch
4. After completing your changes, please ensure that the code style
outlined in `Editorconfig <https://github.com/belbio/bel/blob/master/.editorconfig>`__ is followed.
5. Submit a pull request referencing the issue being resolved
- Other examples of Git Forking workflow
http://www.asmeurer.com/git-workflow/ or
http://blog.scottlowe.org/2015/01/27/using-fork-branch-git-workflow/