Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CONTRIBUTING docs #5

Open
sdhutchins opened this issue Apr 30, 2018 · 2 comments
Open

Add CONTRIBUTING docs #5

sdhutchins opened this issue Apr 30, 2018 · 2 comments

Comments

@sdhutchins
Copy link
Member

No description provided.

@sdhutchins
Copy link
Member Author

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/beRi.
  2. Clone your project: git clone https://github.com/yourname/beRi.git.
  3. Change to the project repository on your machine: cd beri
  4. Create a branch: git checkout -b new-feature.

Development Mode Installation

Ensure that you have poetry installed (pip install --user poetry).

  1. Change to the project repository on your machine: cd beri
  2. Install in development mode: poetry install --develop beri

Making your Changes

  1. Add your contributions
  2. Run tests (use unittest) and make sure they pass.
  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, type the 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 @datasnakes/snakeseq2018 to review!

@sdhutchins
Copy link
Member Author

If anyone has input, please comment. We should add contributing docs to all of the projects. @datasnakes/snakeseq2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants