From 1fd18ea27c9bfe3c61cb13136ac3bff04b5bb822 Mon Sep 17 00:00:00 2001 From: =?utf8?q?=EB=B0=B1=EC=A2=85=EB=AF=BC/Tizen=20Platform=20Lab=28SR=29/?= =?utf8?q?=EC=82=BC=EC=84=B1=EC=A0=84=EC=9E=90?= Date: Tue, 11 Jul 2023 16:41:44 +0900 Subject: [PATCH] Create CONTRIBUTING.md - Migrated some ground rule contents from readme.md to this document (readme.md will be updated soon) - Coding Rules will be revised soon --- CONTRIBUTING.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..a11239b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,37 @@ +# Contributing to ESPlusPlayer + +## Submission Guideline + +### :no_entry_sign: Caution for Code modification +* Apply code modification to this repository only, **not to VD P4**. +> P4 auto-sync is applied to this repository, so the latest of main branch is always synced to VD P4 automatically. + +### Submitting a Pull Request (PR) +* Create your own branch first. That branch can be removed after pull request to main branch is merged or closed. +* Commit the modification to your own branch directly during the code development. It is not mandatory to ask code review at this time. + * Follow Coding Rule when making your commit. +* Create pull request after your modification is completed and ready to commit to main branch. +> Package version needs to be updated together with your modification. (refer `Version:` in [esplusplayer.spec](https://github.sec.samsung.net/tizen-vault/esplusplayer/blob/main/packaging/esplusplayer.spec)) +* Assign the entire [ESPP team](https://github.sec.samsung.net/orgs/tizen-vault/teams/espp) or at least one member in the team for the main reviewer. +* Write the title short but clearly and properly (e.g., `Fix for DFXXXXXX-XXXXX`, `Change A to B`) +* Follow the guideline provided in the [pull request template](https://link-will-be-provided-soon). + +### Reviewing a Pull Request +* When you are assigned as a reviewer of a PR, please try to check the PR as soon as possible. + * review-bot will notify to reviewer group if there is no active review within 6 hours +* When you make a comment for a PR, please write a tag in front of the comment as following:
+`[] ` + +| Tag | Review Action
(Meaning) | Description | +| -- | -- | -- | +| `P1` | `Request changes`
(Please make sure to reflect) | The reviewer requests the review requester to correct the contents of the PR through the `P1` tag if it is deemed necessary to make significant code corrections, such as potentially causing serious errors in the service. The review requester should be able to persuade the reviewer through reasonable opinions that cannot reflect or reflect the reviewer's request for the `P1` tag. | +| `P2` | `Request changes`
(Please consider actively) | The author is encouraged to accept `P2` or listen to appropriate opinions and discuss them if they are unacceptable. | +| `P3` | `Comment`
(Please reflect it as much as possible) | The author is encouraged to accept `P3`, explain why the PR cannot be reflected if it is unacceptable, or explicitly make plans to be reflected next time (such as JIRA tickets). It is used with `Comment`, not `Request changes`. | +| `P4` | `Approve`
(You can reflect it or move on) | The author does not comment on `P4` and can ignore it. It's enough to think about whether it's better to reflect the opinion. +| `P5` | `Approve`
(It's just a small opinion / Nitpick) | The author can ignore `P5` without any comment. | + +### Coding Rules (TBD) +* Commit message format +* Coding style +* About providing test code +* About doxygen if managed API is added -- 2.7.4