updated readme contents

- revised sentences and formatting
- added ground rule about P4 auto sync
- added suggestion and trouble shooting section

diff --git a/README.md b/README.md
index 17541de..4b863ab 100644 (file)
--- a/README.md
+++ b/README.md
@@ -15,21 +15,25 @@ TBD
 
 ## Ground Rule
 
-### When you want to change code...
-* 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))
+### Code modification for ESPP
+* 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.
+
+### When you want to apply code modification...
+* 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.
+* 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))
 
 ### When sending pull request...
 * 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.
+* Write the title short but clearly and properly (e.g., `Fix for DFXXXXXX-XXXXX`, `Change A to B`)
+  * If you want to write further information in the title, write it in the description.
 * Don't make the description empty, please follow the below format:
 
 | Item | Category | Example |
 | --- | --- | --- |
-| Changed Version | Mandatory | `[Version: 1.0.2]` |
+| Updated Version | Mandatory | `[Version: 1.0.2]` |
 | Detailed Explanation | Optional *(but recommended)* | `There was misuse of the API which caused the crash as follows ...` |
 
 > <details>
@@ -42,15 +46,20 @@ TBD
 > * 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.
+> Sometimes detailed explanation may need more than a page of document.\
+> Rather than writing too long 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...
 * 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.
+> If you don't have 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 later.
+
+## Coding Style
+* This project follows [Google C++ Coding Style](https://google.github.io/styleguide/cppguide.html), see the details of guide from [here](https://github.sec.samsung.net/tizen-vault/esplusplayer/blob/main/docs/coding_rule.md)
+> When you send pull request to main branch, review-bot will check the coding style (ReForm service).
 
-## 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)
+## Programming Guide
+* (TBD) Some important changes in ESPlusPlayer and basic guidelines will be provided [here](https://github.sec.samsung.net/tizen-vault/esplusplayer/wiki)
 
-## About Programming Guide
-Some important changes in ESPlusPlayer and basic guidelines will be provided [here](https://github.sec.samsung.net/tizen-vault/esplusplayer/wiki)
+## Suggestion / Trouble Shooting
+* Open new [discussion](https://github.sec.samsung.net/tizen-vault/esplusplayer/discussions) for any idea, or suggestion about ESPP feature or management of this repository.
+* Open new [issues](https://github.sec.samsung.net/tizen-vault/esplusplayer/issues) when you have any problem on ESPP feature or using this repository.