Skip to content
This repository has been archived by the owner on Jan 6, 2020. It is now read-only.

Contributor work flow

David Irvine edited this page Jul 5, 2013 · 14 revisions

#Big thanks First off, we know this is a pretty large and complex code base that's full of new ideas, so the commitment is clear from any contributor. So thanks! The community here is a friendly helpful one that encourages people to do well. The goals are clear, security, privacy and freedom for everyone and we are delighted you have come this far, hopefully this is only the start, so sign up for the mail list and dive right in.

##Fork code The first step is to click on the maidsafe/MaidSafe link above and select the fork button. This will give you your own copy of the superproject.

##Setup repository to work on

(using common as an example, please replace common with the name of the component you will work on)

  1. git clone <your project address>
  2. In the repo you will work on (say common) chdir to src/common type
    git remote set-url origin git@github.com:dirvine/MaidSafe-Common.git change the dirvine to your github name. Then type git remote add --track master upstream git://github.com/maidsafe/MaidSafe-Common.git That is your repository set up to help with code.

Then you can do git pull, git push etc. (this will be from your fork)
git pull upstream <branchname> etc. (from the maidsafe repo)
You will not be able to git push to maidsafe, for that you need to do a pull request.

##Pull requests

Important We will not accept pull requests to master, please select next as the target branch to merge to.

Edit code -> test-> send to dashboard make Exper<reponame> -> commit -> push

When happy then go to github (your projects) and select diff and pull request. This allows you to put in a message and the lib maintainer will get a message to attend to the request.

Each pull request must contain a link to the dashboard to show test results