blob: bbb6ebe821669134b7f60c6c0dd48bbed2ec31bf [file] [log] [blame]
Chris Soyars5c513762010-07-05 03:40:52 +00001CyanogenMod
Steve Kondike5f263c2010-07-11 00:17:02 -04002===========
Chris Soyars5c513762010-07-05 03:40:52 +00003
Steve Kondike5f263c2010-07-11 00:17:02 -04004Submitting Patches
5------------------
Wes Garnera8c03cc2011-01-16 03:07:26 -06006Patches are always welcome! Please submit your patches via CyanogenMod Gerrit!
7You can do this by using these commands:
Chris Soyars5c513762010-07-05 03:40:52 +00008
Wes Garnera8c03cc2011-01-16 03:07:26 -06009 (From root android directory)
10 . build/envsetup.sh
11 (Go to repo you are patching, make your changes and commit)
12 cmgerrit <for(new)/changes(patch set)> <branch/change-id>
Steve Kondike5f263c2010-07-11 00:17:02 -040013
Wes Garnera8c03cc2011-01-16 03:07:26 -060014 repo start gingerbread .
15 (Make your changes and commit)
16 repo upload .
17Note: "." meaning current directory
18For more help on using this tool, use this command: repo help upload
19
20Make your changes and commit with a detailed message, starting with what you are working with (i.e. vision: Update Kernel)
21Commit your patches in a single commit. Squash multiple commit using this command: git rebase -i HEAD~<# of commits>
22
23To view the status of your and others' patches, visit [CyanogenMod Code Review](http://review.cyanogenmod.com/)
24
Steve Kondike5f263c2010-07-11 00:17:02 -040025
26Getting Started
27---------------
28
29To get started with Android/CyanogenMod, you'll need to get
30familiar with [Git and Repo](http://source.android.com/download/using-repo).
31
32To initialize your local repository using the CyanogenMod trees, use a command like this:
33
Wes Garnera8c03cc2011-01-16 03:07:26 -060034 repo init -u git://github.com/CyanogenMod/android.git -b gingerbread
Steve Kondike5f263c2010-07-11 00:17:02 -040035
36Then to sync up:
37
38 repo sync
39
40Please see the [CyanogenMod Wiki](http://wiki.cyanogenmod.com/) for building instructions.
41
42For more information on this Github Organization and how it is structured,
43please [read the wiki article](http://wiki.cyanogenmod.com/index.php/Github_Organization)
44
45Buildbot
46--------
47
48All supported devices are built nightly and periodically as changes are committed to ensure the source trees remain buildable.
49
50You can view the current build statuses at [buildbot.teamdouche.net](http://buildbot.teamdouche.net/)