Skip to content

Commit

Permalink
Merge pull request #128 from datasnakes/dev-master
Browse files Browse the repository at this point in the history
Merge Dev-Master into Master
  • Loading branch information
sdhutchins authored Nov 17, 2017
2 parents 1cd26a1 + a139f4c commit bde0ec8
Show file tree
Hide file tree
Showing 831 changed files with 9,986 additions and 6,606 deletions.
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.pl linguist-vendored
60 changes: 34 additions & 26 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,40 @@
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/OrthoEvolution``.
2. Clone your project: ``git clone git@github.com:yourname/OrthoEvolution``.
3. Create a branch: ``cd OrthoEvolution; git checkout -b foo-the-bars 1.3``.

Development Mode Installation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1. Change to the project repository on your machine: ``cd OrthoEvolution``
2. Install in development mode: ``pip install -e .``


Making your Changes
^^^^^^^^^^^^^^^^^^^
1. Add your contributions
2. Run tests and make sure they pass. (We use unittest.)
3. Commit your changes: ``git commit -m "Foo the bars"``



Creating Pull Requests
^^^^^^^^^^^^^^^^^^^^^^

1. Push your commit to get it back up to your fork: ``git push origin HEAD``
2. Visit Github, click 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 please be patient - we will get to you when
we can.

Version control branching
-------------------------

Expand Down Expand Up @@ -67,31 +101,5 @@ architected and identifies potential edge cases earlier instead of later.
Writing tests before the implementation is strongly encouraged.


Preparing your Fork
^^^^^^^^^^^^^^^^^^^

1. Hit 'fork' on Github, creating e.g. ``yourname/theproject``.
2. Clone your project: ``git clone git@github.com:yourname/theproject``.
3. Create a branch: ``cd theproject; git checkout -b foo-the-bars 1.3``.

Making your Changes
^^^^^^^^^^^^^^^^^^^

1. Add your contributions
2. Run tests and make sure they pass.
3. Commit your changes: ``git commit -m "Foo the bars"``

Creating Pull Requests
^^^^^^^^^^^^^^^^^^^^^^

1. Push your commit to get it back up to your fork: ``git push origin HEAD``
2. Visit Github, click 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 please be patient - we will get to you when
we can.


Thanks to https://contribution-guide-org.readthedocs.io/ for the general guide.
13 changes: 0 additions & 13 deletions Datasnakes/Cookies/README.md

This file was deleted.

3 changes: 0 additions & 3 deletions Datasnakes/Cookies/new_database/cookiecutter.json

This file was deleted.

11 changes: 0 additions & 11 deletions Datasnakes/Manager/BioSQL/biosql/.idea/biosql.iml

This file was deleted.

Loading

0 comments on commit bde0ec8

Please sign in to comment.