Skip to content

Commit

Permalink
DOC: Update contribution guidelines.
Browse files Browse the repository at this point in the history
Hat tips to scikit-learn doc from which the git workflow is from.
http://scikit-learn.org/stable/developers/
  • Loading branch information
cmd-ntrf committed Jul 17, 2014
1 parent 8889cd5 commit 9b3433d
Showing 1 changed file with 35 additions and 7 deletions.
42 changes: 35 additions & 7 deletions doc/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,52 @@ Reporting a bug

You can report a bug on the issue list on google code.

`<http://code.google.com/p/deap/issues/list>`_
`<https://github.com/deap/deap/issues>`_

Retrieving the latest code
--------------------------

You can check the latest sources with the command::

hg clone https://deap.googlecode.com/hg
git clone https://github.com/DEAP/deap.git

If you want to use the development version, you have to update the repository
to the developing branch with the command::

hg update dev

Contributing code
-----------------

Contact us on the deap users list at `<http://groups.google.com/group/deap-users>`_.
The preferred way to contribute to deap is to fork the `main
repository <http://github.com/deap/deap/>`__ on GitHub,
then submit a "pull request" (PR):

1. Fork the `project repository
<http://github.com/deap/deap>`__: click on the 'Fork'
button near the top of the page. This creates a copy of the code under your
account on the GitHub server.

2. Clone your fork locally::

$ git clone [email protected]:YourLogin/deap.git

3. Create a branch to hold your changes::

$ git checkout -b my-feature

and start making changes. Never work in the ``master`` branch!

4. When you're done editing, do::

$ git add modified_files
$ git commit

to record your changes in Git, then push them to GitHub with::

$ git push -u origin my-feature

Finally, go to the web page of your fork of the deap repo,
and click 'Pull request' to send your changes for review.

You can also contact us on the deap users
list at `<http://groups.google.com/group/deap-users>`_.

Coding guidelines
-----------------
Expand Down

0 comments on commit 9b3433d

Please sign in to comment.