From 1787862a65878eb3edd912d844180f5d589bcc2d Mon Sep 17 00:00:00 2001 From: jerdog Date: Tue, 15 Dec 2015 10:32:54 -0600 Subject: [PATCH] Add bit about Maintaining Authorship in our manifest. Idea taken from 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 (cherry picked from commit e9c9f08e4385ea6fd1c250d4764ed202b5e80d7b) --- README.md | 36 +++++++++++++++++++++++++++++++++--- 1 file changed, 33 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index cf8764c..c9d233e 100644 --- a/README.md +++ b/README.md @@ -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 " +``` + +So it should look like this once you get all of the author's information + +```bash +git commit --amend --author "Spencer McGillicuddy " +``` + +Alternatively, adding as part of the original `git commit` message is preferred and done like the following: + +```bash +git commit --author="Author " -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/) -