diff options
author | Shankho Boron Ghosh <shankhoghosh123@gmail.com> | 2020-10-23 00:10:00 +0530 |
---|---|---|
committer | Jan-Simon Moeller <jsmoeller@linuxfoundation.org> | 2020-10-23 10:17:47 +0000 |
commit | de81a8b07f8139fa0f65dddffc839b4a5e83dad7 (patch) | |
tree | ac79454280799638fc7c0f9d6bc9e934b11e8580 /docs/5_How_To_Contribute/4_Submitting_Changes.md | |
parent | 13dda7db03587f9aa6d8095207e0d126b32141c7 (diff) |
Added Contribution Guide
Exhaustive Contribution Guide. Removed Trailing Whitespaces.
Updated index.md. Abandoned accidental commits 25474,
25474 and uploading a new patchset. Corrected code renderings.
v2 (jsmoeller): Update contribution subchapters
Bug-AGL: SPEC-3633
Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com>
Change-Id: Ia808adc0208052f0591396860ac776e34070d279
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25473
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Diffstat (limited to 'docs/5_How_To_Contribute/4_Submitting_Changes.md')
-rw-r--r-- | docs/5_How_To_Contribute/4_Submitting_Changes.md | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/docs/5_How_To_Contribute/4_Submitting_Changes.md b/docs/5_How_To_Contribute/4_Submitting_Changes.md new file mode 100644 index 0000000..36e21f4 --- /dev/null +++ b/docs/5_How_To_Contribute/4_Submitting_Changes.md @@ -0,0 +1,69 @@ +--- +title: Submitting Changes +--- + +Carefully review the following before submitting a change. These +guidelines apply to developers that are new to open source, as well as +to experienced open source developers. + +## Change Requirements + + +This section contains guidelines for submitting code changes for review. +For more information on how to submit a change using Gerrit, please see +[Working with Gerrit](./3_Working_with_Gerrit.md). + +Changes are submitted as Git commits. Each commit must contain: + +- a short and descriptive subject line that is 72 characters or fewer, + followed by a blank line. +- a change description with your logic or reasoning for the changes, + followed by a blank line +- a Signed-off-by line, followed by a colon (Signed-off-by:) +- a Change-Id identifier line, followed by a colon (Change-Id:). Gerrit + won't accept patches without this identifier. + +A commit with the above details is considered well-formed. +[This page](https://chris.beams.io/posts/git-commit/) is a very useful for the +same. + +All changes and topics sent to Gerrit must be well-formed. +Informationally, ``commit messages`` must include: + +- **what** the change does, +- **why** you chose that approach, and +- **how** you know it works -- for example, which tests you ran. + +For example: One commit fixes whitespace issues, another renames a +function and a third one changes the code's functionality. An example +commit file is illustrated below in detail: + +```sh + +A short description of your change with no period at the end + +You can add more details here in several paragraphs, but please keep each line +width less than 80 characters. A bug fix should include the issue number. + +Bug-AGL: [SPEC-<JIRA-ID>] +Change-Id: IF7b6ac513b2eca5f2bab9728ebd8b7e504d3cebe1 +Signed-off-by: Your Name <commit-sender@email.address> +``` + +Include the issue ID in the one line description of your commit message for +readability. Gerrit will link issue IDs automatically to the corresponding +entry in Jira. + +Each commit must also contain the following line at the bottom of the commit +message: + +```sh +Signed-off-by: Your Name <your@email.address> +``` + +The name in the Signed-off-by line and your email must match the change +authorship information. Make sure your :file:``.git/config`` is set up +correctly. Always submit the full set of changes via Gerrit. + +When a change is included in the set to enable other changes, but it +will not be part of the final set, please let the reviewers know this. |