added PR ground rule and revised formatting

- revised sentences and formatting
- changed description format to table syntax
- added versioning rule detailed description using collapsed section
- example is provided using code quotes

diff --git a/README.md b/README.md
index 1e1ef7d..17541de 100644 (file)
--- a/README.md
+++ b/README.md
@@ -14,25 +14,40 @@
 TBD
 
 ## Ground Rule
+
 ### When you want to change code...
-1. Create your own branch first. This branch can be removed later after pull request to main branch is accepted.
-2. You can directly commit to your own branch during the code development. (Don't need to ask review at this time)
-3. After all modification is done and ready to commit to main branch, create pull request.\
-Note that any code change must include package version (in ../packaging/esplusplayer.spec) together.
+* Create your own branch first. This branch can be removed later after pull request to main branch is accepted.
+* You can directly commit to your own branch during the code development. (Don't need to ask review at this time)
+* After all modification is done and ready to commit to main branch, create pull request.
+> Any code change must include **package version** together. (refer `Version:` in [esplusplayer.spec](https://github.sec.samsung.net/tizen-vault/esplusplayer/blob/main/packaging/esplusplayer.spec))
 
 ### When sending pull request...
-1. Write the title short but properly (e.g. Fix DFXXXXXX-XXXXX / Change A to B)
-2. Write further information in description. Don't make the description empty.
-3. Your pull request description needs to follow the below format:
-  - [Version: 1.x.y] (Mandatory)
-  - << further explanation about the change >>
-4. Sometimes further explanation could be more than a page of word document.\
-in this case, use [wiki](https://github.sec.samsung.net/tizen-vault/esplusplayer/wiki) to publish your contents permanantly on this repository.
+* 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 PR title short but clearly and properly (e.g. Fix for DFXXXXXX-XXXXX / Change A to B)
+  * If you want to write further information, write it in the PR description.
+* Don't make the description empty, please follow the below format:
+
+| Item | Category | Example |
+| --- | --- | --- |
+| Changed Version | Mandatory | `[Version: 1.0.2]` |
+| Detailed Explanation | Optional *(but recommended)* | `There was misuse of the API which caused the crash as follows ...` |
+
+> <details>
+> <summary>Versioning Rule</summary>
+>
+> It follows [Semantic Versioning](https://semver.org).
+>
+> * Major Version is fixed to 1, since ESPP's managed API always guarantee compatibility.
+> * Minor Version is increased when new ESPP managed API is created or major big feature is implemented.
+> * Patch Version is increased when there is internal modification or bug fix.
+> </details>
+
+> Sometimes, detailed explanation needs more than a page of word document.\
+> Rather than making too big PR description, use [wiki](https://github.sec.samsung.net/tizen-vault/esplusplayer/wiki) to publish your contents in this repository.
 
 ### During pull request is under review...
-1. You must assign at least [ESPP team](https://github.sec.samsung.net/orgs/tizen-vault/teams/espp) for the reviewer.
-2. Don't ignore analysis comes from review-bot, always check its comment and try to revise your pull request.\
-If you have not enough time to follow up the review-bot analysis result, use [issues](https://github.sec.samsung.net/tizen-vault/esplusplayer/issues) to assign it and follow up soon later.
+* Don't ignore analysis comes from review-bot, always check its comment and try to revise your pull request.
+> If you have not enough time to follow up the review-bot analysis result, use [issues](https://github.sec.samsung.net/tizen-vault/esplusplayer/issues) to assign it and follow up soon later.
 
 ## About Coding Rule
 This project follows Google C++ Coding Style, see the details of guide from [here](https://github.sec.samsung.net/tizen-vault/esplusplayer/blob/main/docs/coding_rule.md)