Difference between revisions of "Contributing code"

From Omni
Jump to: navigation, search
(Steps to Contribute Code to Omnirom)
Line 18: Line 18:
 
   '''EXAMPLE:''' repo start bootAnimation vendor/omni
 
   '''EXAMPLE:''' repo start bootAnimation vendor/omni
  
'''Note:''' it is important to use relative path names to where you are in your repo.
+
::'''Note:''' it is important to use relative path names to where you are in your repo.
  
 
== Licensing ==
 
== Licensing ==
  
 
It is important that any code you contribute follows either the existing licensing, or utilizes the correct licensing. For pre-created headers, see the [[License template]]
 
It is important that any code you contribute follows either the existing licensing, or utilizes the correct licensing. For pre-created headers, see the [[License template]]

Revision as of 19:12, 1 November 2013

Steps to Contribute Code to Omnirom

The beauty of open source projects is the ability for even the most novice of developers to be involved in determining the trajectory of the project. The difficulty is in knowing exactly how to submit your patch for code review and (hopefully) inclusion into the project.

Below are the simple, basic steps for contributing code:

  1. Begin by performing a repo sync so that we know we’re dealing with the most recent versions of the code. We're also assuming that you have your Omnirom repo in ~/android/omni:
 cd ~/android/omni
 repo sync
  1. Now go and make the changes to the files you are wanting to patch/include.
  1. Once done, navigate to the root of the project, i.e. the root of your local repo
 cd ~/android/omni
  1. Begin a new branch of the local repo so that you can track your changes
 SYNTAX: repo start <branchName> <directoryOfPackageChanged>
 EXAMPLE: repo start bootAnimation vendor/omni
Note: it is important to use relative path names to where you are in your repo.

Licensing

It is important that any code you contribute follows either the existing licensing, or utilizes the correct licensing. For pre-created headers, see the License template