| Chris Soyars | 5c51376 | 2010-07-05 03:40:52 +0000 | [diff] [blame] | 1 | CyanogenMod |
| Steve Kondik | e5f263c | 2010-07-11 00:17:02 -0400 | [diff] [blame] | 2 | =========== |
| Chris Soyars | 5c51376 | 2010-07-05 03:40:52 +0000 | [diff] [blame] | 3 | |
| Steve Kondik | e5f263c | 2010-07-11 00:17:02 -0400 | [diff] [blame] | 4 | Submitting Patches |
| 5 | ------------------ |
| Wes Garner | a8c03cc | 2011-01-16 03:07:26 -0600 | [diff] [blame] | 6 | Patches are always welcome! Please submit your patches via CyanogenMod Gerrit! |
| 7 | You can do this by using these commands: |
| Chris Soyars | 5c51376 | 2010-07-05 03:40:52 +0000 | [diff] [blame] | 8 | |
| Wes Garner | a8c03cc | 2011-01-16 03:07:26 -0600 | [diff] [blame] | 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> |
| Steve Kondik | e5f263c | 2010-07-11 00:17:02 -0400 | [diff] [blame] | 13 | |
| ciwrl | a57590d | 2013-01-14 21:57:39 -0800 | [diff] [blame^] | 14 | repo start cm-10.1 . |
| Wes Garner | a8c03cc | 2011-01-16 03:07:26 -0600 | [diff] [blame] | 15 | (Make your changes and commit) |
| 16 | repo upload . |
| 17 | Note: "." meaning current directory |
| 18 | For more help on using this tool, use this command: repo help upload |
| 19 | |
| 20 | Make your changes and commit with a detailed message, starting with what you are working with (i.e. vision: Update Kernel) |
| 21 | Commit your patches in a single commit. Squash multiple commit using this command: git rebase -i HEAD~<# of commits> |
| 22 | |
| codeworkx | 22122ea | 2013-01-18 16:41:55 +0000 | [diff] [blame] | 23 | To view the status of your and others' patches, visit [CyanogenMod Code Review](http://review.cyanogenmod.org/) |
| Wes Garner | a8c03cc | 2011-01-16 03:07:26 -0600 | [diff] [blame] | 24 | |
| Steve Kondik | e5f263c | 2010-07-11 00:17:02 -0400 | [diff] [blame] | 25 | |
| 26 | Getting Started |
| 27 | --------------- |
| 28 | |
| 29 | To get started with Android/CyanogenMod, you'll need to get |
| ciwrl | a57590d | 2013-01-14 21:57:39 -0800 | [diff] [blame^] | 30 | familiar with [Repo](https://source.android.com/source/using-repo.html) and [Version Control with Git](https://source.android.com/source/version-control.html). |
| Steve Kondik | e5f263c | 2010-07-11 00:17:02 -0400 | [diff] [blame] | 31 | |
| 32 | To initialize your local repository using the CyanogenMod trees, use a command like this: |
| 33 | |
| codeworkx | 22122ea | 2013-01-18 16:41:55 +0000 | [diff] [blame] | 34 | repo init -u git://github.com/CyanogenMod/android.git -b cm-10.1 |
| Steve Kondik | e5f263c | 2010-07-11 00:17:02 -0400 | [diff] [blame] | 35 | |
| 36 | Then to sync up: |
| 37 | |
| 38 | repo sync |
| 39 | |
| ciwrl | a57590d | 2013-01-14 21:57:39 -0800 | [diff] [blame^] | 40 | Please see the [CyanogenMod Wiki](http://wiki.cyanogenmod.org/) for building instructions, by device. |
| Steve Kondik | e5f263c | 2010-07-11 00:17:02 -0400 | [diff] [blame] | 41 | |
| 42 | For more information on this Github Organization and how it is structured, |
| ciwrl | a57590d | 2013-01-14 21:57:39 -0800 | [diff] [blame^] | 43 | please [read the wiki article](http://wiki.cyanogenmod.org/w/Github_Organization) |
| Steve Kondik | e5f263c | 2010-07-11 00:17:02 -0400 | [diff] [blame] | 44 | |
| 45 | Buildbot |
| 46 | -------- |
| 47 | |
| 48 | All supported devices are built nightly and periodically as changes are committed to ensure the source trees remain buildable. |
| 49 | |
| ciwrl | a57590d | 2013-01-14 21:57:39 -0800 | [diff] [blame^] | 50 | You can view the current build statuses in the [Jenkins](http://jenkins.cyanogenmod.org) tool. |