https://github.com/prestashop/prestonbot
Preston, the PrestaShop contributor's best friend! :sparkles:
https://github.com/prestashop/prestonbot
assistant bot github-bot hacktoberfest tool
Last synced: 4 months ago
JSON representation
Preston, the PrestaShop contributor's best friend! :sparkles:
- Host: GitHub
- URL: https://github.com/prestashop/prestonbot
- Owner: PrestaShop
- License: gpl-3.0
- Archived: true
- Created: 2016-09-11T22:47:39.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-06-07T13:18:16.000Z (over 1 year ago)
- Last Synced: 2024-09-26T11:40:46.068Z (over 1 year ago)
- Topics: assistant, bot, github-bot, hacktoberfest, tool
- Language: PHP
- Homepage:
- Size: 1.48 MB
- Stars: 22
- Watchers: 27
- Forks: 20
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PrestonBot
> [!WARNING]
> This project is now inactive. Prestonbot has been replaced in May 2024 by [Kanbanbot](https://github.com/PrestaShop/kanbanbot) a more modern implementation
This application is based on Symfony CarsonBot and aims to help PrestaShop maintainers and contributors.
### Classic installation
First of all you have to configure your GitHub repository and have a GitHub token.
```bash
composer install // and complete the interactive fields asked
```
### Docker installation
First, setup the `docker-compose.yml` file with a valid GitHub token and a valid Secure token (can be empty).
```bash
make start
```
The Home page is now available at "http://localhost:81/".
You need also to create your own GitHub [personal token](https://github.com/settings/tokens) and export it:
```bash
export GH_TOKEN=XXXXXXXXXXXXXXXXXXXXXXXXXXXX
export GH_SECURED_TOKEN=YYYYYYYYYYYYYYYYYYYYYYYYYYYY
```
## How to run the test suite ?
```bash
./vendor/bin/simple-phpunit
# or (using docker)
make test
```
> To launch unit tests, you only need to setup your own Github token (`GH_TOKEN`).
## Our standards ?
Yeah, mostly the *Symfony* ones:
```bash
./vendor/bin/php-cs-fixer fix # we use the Symfony level + short array notation filter
```
## What is Preston capable of doing?
* Comment on a pull request to help a contributor fix his work;
* Extract data from the pull request and look for some terms;
* Manage labels;
* Validate a pull request description;
* Welcome every new contributor;
* Labelize a PR regarding information in description
* Labelize a PR regarding files updated
* Add labels according to the branch