asgardius/platform_manifest_twrp_omni
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add bit about Maintaining Authorship in our manifest. Idea taken from

Browse source 
Dirty Unicorns

(https://github.com/DirtyUnicorns/android_manifest/blob/lollipop/README.md)

PS2: updated committer email
PS3: updated author to match committer
PS4: Added authorship argument as part of the normal git commit method

Change-Id: Ia1fa0303fa6e7748b05cad2113ed1b1a49b7ea37
This commit is contained in:
jerdog 2015-12-15 10:32:54 -06:00
parent d3a23f1712
commit e9c9f08e43
1 changed files with 33 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
README.md
View file

@ -1,4 +1,4 @@
Submitting Patches
## Submitting Patches ##
------------------
Our ROM is open source, and patches are always welcome!
You can send patches by using these commands:
@ -19,7 +19,38 @@ use git commit --amend. Gerrit will recognize it as a new patchset.
To view the status of your and others patches, visit [OMNI ROM Code Review](https://gerrit.omnirom.org)
Getting Started
## Maintaining Authorship ##
----------------------
Mainting authorship is a very important aspect of working with Open Source code. If you wish to submit a patch/fix
from anywhere else (another ROM, project, etc.), it is imperative that you maintain the ownership of the person whose
work you're seeking to include. Doing so will ensure that credit is given where it is deserved, and the [prinicples of open source](http://opensource.org/docs/osd)
are upheld. Your contribution to the project will still be recognized as you will forever be listed as the committer.
If you manually cherry pick a patch/fix then you will need to add the original author prior to pushing to our [gerrit](https://gerrit.omnirom.org).
This is a very easy task to perform, and is usually done after you commit a patch/fix locally. This is accomplished
after you type in `git commit -a` , type in the commit message and save. You would then do the following:
```bash
git commit --amend --author "Author <email@address.com>"
```
So it should look like this once you get all of the author's information
```bash
git commit --amend --author "Spencer McGillicuddy <spencer.the.bestest@gmail.com>"
```
Alternatively, adding as part of the original `git commit` message is preferred and done like the following:
```bash
git commit --author="Author <email@address.com>" -m "[commit message]"
```
This saves time, and when part of your normal routine, prevents the infamous "ermahgerd I forgot to add authorship -
let me fix it because I was found out!" message.
## Getting Started ##
---------------
To get started with OMNI ROM, you'll need to get
@ -45,4 +76,3 @@ Our official IRC Channels are hosted on Freenode:
[#omnirom - USERS](http://webchat.freenode.net/?channels=omnirom/)
[#omni - DEVELOPERS](http://webchat.freenode.net/?channels=omni/)