aboutsummaryrefslogtreecommitdiffstats
path: root/docs/5_How_To_Contribute/4_Submitting_Changes.md
diff options
context:
space:
mode:
authorJan-Simon Moeller <jsmoeller@linuxfoundation.org>2021-01-14 18:18:25 +0100
committerJan-Simon Moeller <jsmoeller@linuxfoundation.org>2021-01-20 23:52:26 +0000
commitf81a7f42d8f10467108bab784117a380e0070ece (patch)
tree28f7c7a31cc279f176508cc4eb0f9dc3b3e2acbe /docs/5_How_To_Contribute/4_Submitting_Changes.md
parent48873cd821ac1cd50bf33a737a898f4c58702a62 (diff)
Add a category for agl-compositor and rba documentation
Create a home for docs of compositor, rba and pipewire/wireplumber. Also add a .gitignore file. Signed-off-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Change-Id: Id1f9812d0f4db83cb72bf03987dc95d754e00725 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25913
Diffstat (limited to 'docs/5_How_To_Contribute/4_Submitting_Changes.md')
-rw-r--r--docs/5_How_To_Contribute/4_Submitting_Changes.md68
1 files changed, 0 insertions, 68 deletions
diff --git a/docs/5_How_To_Contribute/4_Submitting_Changes.md b/docs/5_How_To_Contribute/4_Submitting_Changes.md
deleted file mode 100644
index d226450..0000000
--- a/docs/5_How_To_Contribute/4_Submitting_Changes.md
+++ /dev/null
@@ -1,68 +0,0 @@
----
-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.