Skip to content

Latest commit

 

History

History
90 lines (61 loc) · 4.28 KB

README.md

File metadata and controls

90 lines (61 loc) · 4.28 KB
Raw

Dirty Unicorns

Setting up your build environment and syncing our source

To set up your build environment and sync DU, please follow this guide: Link

Submitting Patches

Dirty Unicorns is an open source project and welcomes new contributors.

To start contributing to DU, just register at "gerrit.dirtyunicorns.com".

Open up a Terminal window to create your ssh keys required for submitting patches to Gerrit and type in:

git config --global review.gerrit.dirtyunicorns.com.username <username you registered with>

git config --global review.gerrit.dirtyunicorns.com.email <your email you registered with>

ssh-keygen -t rsa -C "your@email.com"

In our Gerrit, click on the 'Settings' icon in the top right corner next to username.

Now on your computer navigate to your home "~/.ssh", open up "id_rsa.pub" and copy the entire content of the file. While in 'Settings' Click on "SSH Keys" on the left-hand side and then on "ADD NEW SSH KEY" after copying your key into the field.

You can send patches to us by using these commands in Terminal:

cd PROJECT - i.e cd packages/apps/Settings

Make whatever edits you need to .....

git add -A
git commit -a

Add commit message that makes sense for others to understand what the commit is for.

Ctrl X, then Y to save and Enter:

git push ssh://<username>@gerrit.dirtyunicorns.com:29418/<project> HEAD:refs/for/<branch>

To submit private changes you can also use:

git push ssh://<username>@gerrit.dirtyunicorns.com:29418/<project> HEAD:refs/for/<branch>%private
  • <username> - Your Gerrit username (which can be seen/set here)
  • <project> - The git repo you are pushing to; all options can be viewed at this link
  • <branch> - The git branch your change is based on; for projects using this manifest, it is r11x

A full command would look like:

git push ssh://dualexcruz@gerrit.dirtyunicorns.com:29418/android_packages_apps_Settings HEAD:refs/for/r11x

If you are going to make extra additions, just repeat steps (don't start a new patch), but instead of git commit -m use git commit --amend. Gerrit will recognize it as a new patchset. Do NOT change the Change-Id in the commit message.

For more information on how to push to Gerrit, please reference the Gerrit documentation: Link

If you still can not figure it out, don't hesitate to contact us in our Telegram support chat: Link

Maintaining Authorship

Please make sure if you submit a patch/fix from another ROM that you maintain authorship. This is very important to not only us but to the entire open source community. It's what keeps it going and encourages more developers to contribute their work.

If you manually cherry pick a patch/fix please add the original author prior to pushing to our Gerrit. This task is very easy and is usually done after you commit a patch/fix locally.

i.e - Once you type in "git commit -a" the commit message and you have saved it, type in the following:

git commit --amend --author "Author <email@address.com>"

So it should look like this once you get all author's information:

git commit --amend --author "Alex Cruz <du.alexcruz@gmail.com>"

If you do not want to clone or fetch the repo and the patch is on GitHub, you can easily get the author of the patch by adding .patch to the end of the commit URL and copy the contents of the lines after the From:.

For example: https://github.com/DirtyUnicorns/android_manifest/commit/9d44b2e34fd0b6674de79d001010e513ba14e312.patch

It is also recommended that you keep the date intact as well as it helps other open source users figure out the original version that a patch may have come from. Copy the contents of the date line after the Date: then add --date="<date_just_copied>" to the above git commit --amend command.