Added some docs on Labelization system

loveOSS · Jul 23, 2016 · 839d5dc · 839d5dc
1 parent 03b33f9
commit 839d5dc
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 1 deletion.
diff --git a/doc/bot_part.md b/doc/bot_part.md
@@ -0,0 +1,28 @@
+# Bot part of PrestonBot
+
+## Labelization system
+
+PrestonBot have automatic and semi-automatic labelization capacities.
+
+### Semi-automatic Labelization
+
+If you add a comment with certains "patterns", PrestonBot will automatically 
+add a label to the pull request:
+
+| Pattern to put in a comment  | Label added
+|------------------------------|----------------
+| ``Status: 'QA approved'``    | ``QA-approved``
+| ``Status: 'PM approved'``    | ``PM-approved``
+
+> This feature is usable for everyone, if required we will restrict the feature
+only to PrestaShop team.
+
+### Automatic Labelization
+
+> This is not available for now (23/07/2016)
+
+On pull request creation, PrestonBot will automatically add a ``to be reviewed``
+label. Why ? Because this allow us to do some statistics more easily. Also,
+the dev core team will be able to receive everyday the 5 to 10 lasts pull requests
+contributed.
+
diff --git a/doc/installation.md b/doc/installation.md
@@ -81,7 +81,6 @@ swiftmailer:
     username:  "%mailer_user%"
     password:  "%mailer_password%"
     spool:     { type: memory }
-
 ```
 
 we should see:

diff --git a/doc/response_apis.md b/doc/response_apis.md