Skip to content
This repository was archived by the owner on Apr 10, 2024. It is now read-only.

Commit 05f140f

Browse files
committed
docs: Move everything commit related to a dedicated guideline document
Signed-off-by: Henrique Pereira <henrique.pereira@signativa.com.br>
1 parent 190695d commit 05f140f

File tree

2 files changed

+23
-10
lines changed

2 files changed

+23
-10
lines changed

commits_guidelines.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Commit Guidelines:
2+
3+
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc2119).
4+
5+
Exceptions **SHOULD** be made by contacting the administration team.
6+
7+
- The commit's message **MUST** have its content clear to anyone that wants to know what the commit is about. There is absolutely no need for the commit message to contain Linux Foundation's like documentation, however something that an average newbie developer would understand is required. Extra documentation/explanation **MUST** be there if the commit's content is huge, and also will always be welcome.
8+
9+
- The commit's message **MUST** have an indicator of where the commit introduces changes, therefor following the standard: "<path/repository name reference>: <Commit title that **MUST** be a basic explanation for its content>".
10+
11+
- The commit **MUST** be necessary for the device to build, boot, or even to have a/the device's function(s) working properly (e.g. Fingerprint On Display).
12+
13+
- The commit **MUST** have proper authorship.
14+
15+
- If a commit is for the ROM side, the same **MUST** be pushed to [Gerrit](https://gerrit.pixelexperience.org).
16+
17+
- The commit's content **MUST** be as minimal and polished as possible.
18+
19+
- The commit **MUST** be in accordance with the items, if applicable, stated at our [Maintainers Code of Conduct](https://github.com/PixelExperience/docs/blob/master/maintainers_code_of_conduct.md).
20+
21+
- For revert commits, the same **SHOULD** contain reason for revert point - if possible at all. As stated previously, any extra bit of documentation in the commit's message is welcome.

device_requirements.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,6 @@ Exceptions **SHOULD** be made by contacting the administration team.
2222

2323
- The device **MUST NOT** have the need for a lot of patches, and if so, it must be in accordance with the following listing below.
2424

25-
- If there are commits that are needed in repos other than the device-specific ones, they **MUST**:
25+
- If there are commits that are needed in repos other than the device-specific ones, they **MUST** be in accordance with our [Commit's Guidelines](https://github.com/PixelExperience/docs/blob/master/commits_guidelines.md).
2626

27-
- Be necessary for the device to build, boot, or even to have a/the device's function(s) working properly (e.g. Fingerprint On Display).
28-
29-
- Have proper authorship.
30-
31-
- Be pushed to [Gerrit](https://gerrit.pixelexperience.org).
32-
33-
- Be as minimal and polished as possible.
34-
35-
- Be in accordance with the items, if applicable, stated at our [Maintainers Code of Conduct](https://github.com/PixelExperience/docs/blob/master/maintainers_code_of_conduct.md).
27+
- The device **MUST** have on it's sources commit complying with our [Commit's Guidelines](https://github.com/PixelExperience/docs/blob/master/commits_guidelines.md).

0 commit comments

Comments
 (0)