Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Added docs
  • Loading branch information
mickaelandrieu committed Oct 28, 2016
1 parent d89f319 commit e931261
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 34 deletions.
Empty file removed doc/add_subscribers.md
Empty file.
Empty file removed doc/architecture.md
Empty file.
29 changes: 0 additions & 29 deletions doc/bot_part.md

This file was deleted.

Empty file removed doc/dashboard_part.md
Empty file.
23 changes: 23 additions & 0 deletions 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.
6 changes: 1 addition & 5 deletions doc/installation.md
Expand Up @@ -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
Expand Down Expand Up @@ -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.

0 comments on commit e931261

Please sign in to comment.