Skip to content

How to Contribute Code

Jump to bottom Edit New page
toddsampson edited this page Mar 14, 2013 · 3 revisions

Since most of Ardrobot is open-source, we would appreciate if you dive in and start adding features, fixing bugs, and cleaning up the code.

How to Contribute

Third-party patches are essential for keeping Ardrobot great. We simply can't access the huge number of bots and configurations for running Ardrobot. We want to keep it as easy as possible to contribute changes that get things working in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.

Making Changes

  • Make sure you have a GitHub Account
  • Submit a ticket for your issue, assuming one does not already exist.
    • Clearly describe the issue including steps to reproduce when it is a bug.
    • Make sure you fill in the earliest version that you know has the issue.
  • Fork the repository you wish to contribute to -- we have separate repos for the Ardrobot Server, Android, Arduino, etc. -- on GitHub. If you have previously forked the repo, be sure you update it to the latest code.
  • Clone your fork of the Ardrobot repository to your development machine.
  • Add a remote for the main Ardrobot repo
    • To make things easier to integrate and to keep your fork up to date then you need to add the main Kandan repo as a remote reference.
    • git remote add upstream https://github.com/ardrobot/[ArdrobotRepo].git where ArdrobotRepo is the repo you are working on
    • When you need to pull the latest from the main Ardrobot repo, you just run: git pull upstream master
  • Make a branch for your changes
    • Create a branch from where you want to base your work.
    • Generally you'll want to branch from MASTER
    • Please use the naming convention "[ardrobotrepo]-[issue-num]" for your branch name to help us keep track of what your patch actually fixes
  • Push your code and make a pull request
    • One pull request per issue. Do NOT try and fix multiple issues with a single pull request.
    • Please make your commit messages and pull requests informative. i.e. 'Moved version string to git_revision Fixes #123'. By using the Fixes/Fixed #Issue-Number in the commit message it will allow for closing of issues once the pull request is merged. For more information please read this.
    • Push your changes to your fork of the repository: git push origin [ardrobotrepo]-[issue-num]
    • Submit a pull request to the main Ardrobot repository you are working on.

At this point you're waiting on us. We like to at least comment on, if not accept, pull requests within two business days (and, typically, a few hours). We may suggest some changes or improvements or alternatives.

##Additional Resources

Additional Note on Pull Requests

When we have multiple PRs for the same issue. We will choose the best, or if equal, the first. Thanks for understanding.

Thanks

Thanks to our friends at Kandan for letting us crib from their contributor how-tos.

Add a custom footer
Add a custom sidebar

Clone this wiki locally