• Created by Unknown User (isart_canyameres), last modified on 16 Jan, 2013

To contribute to OpenNaaS you'll first need git installed and access to OpenNaaS source code. Please, read the build the project section for instructions on how to do that.

Assuming there is a branch in your local git repository with the changes you'd like to contribute, you just need to send us a documented patch with the changes.

The suggested way to do that is by sending a pull request using github.

 

Contribute using GitHub

This document will guide you create and account to github, upload the code there and make a pull request with your changes.

This guide assumes your code is open-source and can be publicly displayed. If that's not the case, please contact the development list for alternatives before uploading the code following this guide.


First of all, create a github account (or use an existing one) and upload the code there. No matter the branch you choose.
To create an account, please visit this site:
https://github.com/signup/free

With an account, you can upload your code to it by following these steps:

  1. Create the remote repository, and get the URL such as git@github.com:your-username/project-name.git
  2. Attach your remote repo with the name you like [repo-name] in your local git repository (in your computer):
    >git remote add repo-name [URL From Step 1]
  3. Push your branch to your repo: >git push repo-name your-branch-name

 

Then, to be sure your code works with the last version of opennaas, you'll need to pull our master branch, merge it to your branch, and check everything is working as expected. When everything is fine, push the merged branch into github and make a pull request with it.

To make a pull request, go to your github project, select the desired branch and push the "Pull Request" button. In the appearing web page, make sure dana-i2cat/opennas is selected as the base repo and develop is selected as a base-branch. Please, check head repo and branch point to the code you actually want to contribute.

In this same screen, please provide a detailed documentation of the changes you are contributing. Specifying new features, required configuration and also design and implementation details.

The development team will review the pull request, comment it if necessary (commonly to clarify doubts) and eventually merge it to opennaas develop branch (or reject it).

We are kind to contributors and try to help in everything we are able to. Please, ask the development list for any doubt.

 

  • No labels