Skip to content

Latest commit

 

History

History
27 lines (18 loc) · 1.24 KB

CONTRIBUTING.md

File metadata and controls

27 lines (18 loc) · 1.24 KB
Raw

Contributing to this project

Thanks for your desire to contribute to this project!

Preparing your fork

  1. Hit 'fork' on Github, creating e.g. yourname/mgap-api.
  2. Clone your project: git clone https://github.com/yourname/mgap-api.git.
  3. Create a branch: cd mgap-api; git checkout -b new-feature.

Development Mode Installation

  1. Change to the project repository on your machine: cd mgap-api
  2. Install in development mode: pip install -e .

Making your changes

  1. Add your contributions and please adhere to Google's python style guide.
  2. Run tests and make sure they pass. (I intend to use unittest.)
  3. Commit your changes: git commit -m "Added new feature" and please be descriptive with git commits!

Creating Pull Requests

  1. Push your commit to get it back up to your fork: git push origin HEAD.
  2. Visit Github, click the handy "Pull request" button that it will make upon noticing your new branch.
  3. In the description field, write down issue number (if submitting code fixing an existing issue) or describe the issue + your fix (if submitting a wholly new bugfix).
  4. Hit 'submit' and ask for vallenderlab to review, and we will get to you as soon as we can.