Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
Added docs
- Loading branch information
1 parent
d89f319
commit e931261
Showing
6 changed files
with
24 additions
and
34 deletions.
There are no files selected for viewing
Empty file.
Empty file.
This file was deleted.
Oops, something went wrong.
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters