Difference between revisions of "Contributing"

From PaparazziUAV
Jump to: navigation, search
(fix link to styleguide)
m (Reverted edits by Flixr (talk) to last revision by Rufus)
Line 16: Line 16:
 
Also see the [[Git|Git wiki page]] for more details about setting up Git and cloning the source-code and data repository.
 
Also see the [[Git|Git wiki page]] for more details about setting up Git and cloning the source-code and data repository.
  
Please also have a look at the [http://docs.paparazziuav.org/latest/styleguide.html Coding Style Guide].
+
Please also have a look at the [http://paparazzi.github.com/docs/latest/styleguide.html Coding Style Guide].
  
 
Here is the short version if you already know git:
 
Here is the short version if you already know git:
Line 22: Line 22:
 
# Fork the [http://github.com/paparazzi/paparazzi/ papaprazzi repo] on github. (After logging in press the '''fork''' button).
 
# Fork the [http://github.com/paparazzi/paparazzi/ papaprazzi repo] on github. (After logging in press the '''fork''' button).
 
# '''git clone git@github.com:<yourname>/paparazzi.git'''
 
# '''git clone git@github.com:<yourname>/paparazzi.git'''
# '''git remote add upstream https://github.com/paparazzi/paparazzi.git'''
+
# '''git remote add upstream git@github.com:paparazzi/paparazzi.git'''
 
# '''git fetch upstream'''
 
# '''git fetch upstream'''
 
# checkout a new branch based on the development branch (master):<br/>'''git checkout -b upstream/master my_new_feature'''
 
# checkout a new branch based on the development branch (master):<br/>'''git checkout -b upstream/master my_new_feature'''

Revision as of 12:40, 24 January 2014

How to contribute

There are of course lots of ways to contribute to Paparazzi and get involved.

Help is always welcome on all aspects of the project. May this be documentation, wiki, maintenance, electronics or code contributions/fixes.

Wiki

Just create an account and you can start adding information, cleaning it up or just fixing some typo you just noticed :-)

Some information and links on how to edit the wiki can be found at Help:Editing.

Please be aware of past edits and page histories. Try not to remove this; if you are moving/renaming a page, use the move tab at the top of a page. This ensures the revision history is moved with the page.

Software development

We use the distributed version control system git. The Papaprazzi master repository is hosted on Github.

Also see the Git wiki page for more details about setting up Git and cloning the source-code and data repository.

Please also have a look at the Coding Style Guide.

Here is the short version if you already know git:

  1. Create an account on github.
  2. Fork the papaprazzi repo on github. (After logging in press the fork button).
  3. git clone git@github.com:<yourname>/paparazzi.git
  4. git remote add upstream git@github.com:paparazzi/paparazzi.git
  5. git fetch upstream
  6. checkout a new branch based on the development branch (master):
    git checkout -b upstream/master my_new_feature
  7. fix/code and commit in logical units
  8. push your feature/bugfix branch
  9. Send us a pull request on github. (Or send patches to the mailing list).

Issue/Feature Tracker

To report bugs, issues and feature request please use either the mailing list or even better the simple issue tracker on github

Continuous Integration Builds

We have a build server running some CI tests.