diff --git a/doc/add_subscribers.md b/doc/add_subscribers.md deleted file mode 100644 index e69de29..0000000 diff --git a/doc/architecture.md b/doc/architecture.md deleted file mode 100644 index e69de29..0000000 diff --git a/doc/bot_part.md b/doc/bot_part.md deleted file mode 100644 index e782d1c..0000000 --- a/doc/bot_part.md +++ /dev/null @@ -1,29 +0,0 @@ -# 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`` -| ``Status: 'Code reviewed'`` | ``Code reviewed`` - -> 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/dashboard_part.md b/doc/dashboard_part.md deleted file mode 100644 index e69de29..0000000 diff --git a/doc/features.md b/doc/features.md new file mode 100644 index 0000000..670bf6c --- /dev/null +++ b/doc/features.md @@ -0,0 +1,23 @@ +# "Bot/social" features + +## Pull request description parser + +PrestonBot is able to check the pull request description if any and validate against defined business rules. +This allow both maintainers and contributors to review the pull request. + +## Pull request commit name parser + +PrestonBot is able to check every commit of a pull request. As we have some guidelines regarding the name of +commit, we can help the contributor to respect them. + +## Git diff static analyser + +PrestonBot is able to check the git diff of a pull request and react to help both contributors and maintainers. +For instance, we use it to inform our Translation team leader when a translation have been added or updated in PrestaShop. + +# Command Line features + +## Activity report + +PrestonBot send activity report of pull requests, ordered by date of last update and label. +You can configure groups of users and emails, see `app/config/parameters.yml.dist` file. diff --git a/doc/installation.md b/doc/installation.md index e532017..203d6d3 100644 --- a/doc/installation.md +++ b/doc/installation.md @@ -58,11 +58,9 @@ The application needs ``mod_rewrite`` to be enabled and the following configurat ## Routing -There are actualy 4 routes/urls defined: +There are actualy 2 routes/urls defined: * / [GET] -* /dashboard/teams [GET] -* /dashboard/pull_requests [GET] * /webhooks/github [POST] Only the **last one** MUST be totaly public to everyone, because this is the url needed @@ -106,5 +104,3 @@ we also need a cron task in order to "daily" executes a mail sending: ``` bin/console p:r:s ``` - -On the root of application. \ No newline at end of file