blob: dbe72e06f119f8af33a015733470b73d2814c94e [file] [log] [blame]
Chris Soyars878bc022011-11-14 21:41:03 -05001CyanogenMod
2===========
3
4Submitting Patches
5------------------
6Patches are always welcome! Please submit your patches via CyanogenMod Gerrit!
7You can do this by using these commands:
8
9 (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>
13
Al Sutton9486c272014-11-09 10:40:23 +000014 repo start cm-12.0 .
Chris Soyars878bc022011-11-14 21:41:03 -050015 (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
Ricardo Cerqueirad15b0862012-11-14 20:29:52 +000023To view the status of your and others' patches, visit [CyanogenMod Code Review](http://review.cyanogenmod.org/)
Chris Soyars878bc022011-11-14 21:41:03 -050024
25
26Getting Started
27---------------
28
29To get started with Android/CyanogenMod, you'll need to get
Kevin Cernekee4efef8e2013-06-02 13:30:09 -070030familiar with [Git and Repo](http://source.android.com/source/using-repo.html).
Chris Soyars878bc022011-11-14 21:41:03 -050031
32To initialize your local repository using the CyanogenMod trees, use a command like this:
33
Al Sutton9486c272014-11-09 10:40:23 +000034 repo init -u git://github.com/CyanogenMod/android.git -b cm-12.0
Chris Soyars878bc022011-11-14 21:41:03 -050035
36Then to sync up:
37
38 repo sync
39
Ricardo Cerqueirad15b0862012-11-14 20:29:52 +000040Please see the [CyanogenMod Wiki](http://wiki.cyanogenmod.org/) for building instructions.
Chris Soyars878bc022011-11-14 21:41:03 -050041
42For more information on this Github Organization and how it is structured,
Kevin Cernekee4efef8e2013-06-02 13:30:09 -070043please [read the wiki article](http://wiki.cyanogenmod.org/w/Github_Organization)
Chris Soyars878bc022011-11-14 21:41:03 -050044
45Buildbot
46--------
47
48All supported devices are built nightly and periodically as changes are committed to ensure the source trees remain buildable.
49
Ricardo Cerqueirad15b0862012-11-14 20:29:52 +000050You can view the current build statuses at [CyanogenMod Jenkins](http://jenkins.cyanogenmod.org/)