https://github.com/xavierchow/pr-diverge-reminder
https://github.com/xavierchow/pr-diverge-reminder
bot pullrequest rebase reminder
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/xavierchow/pr-diverge-reminder
- Owner: xavierchow
- License: isc
- Created: 2020-01-11T14:59:14.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-23T12:58:01.000Z (over 1 year ago)
- Last Synced: 2025-02-10T13:43:25.439Z (over 1 year ago)
- Topics: bot, pullrequest, rebase, reminder
- Language: JavaScript
- Homepage: https://github.com/apps/pr-diverge-reminder
- Size: 118 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# pr-diverge-reminder
> A GitHub App built with [Probot](https://github.com/probot/probot) that A probot App reminds you when the base branch changes
# Usage
There are a few assumptions to use this bot,
1. You use Github pull request in your workflow.
2. You prefer linear git history when incorporating the feature branch
3. To accomplish step 2, you always use `git rebase` to update your pull request.
If you sometimes forget to update your pull request before merging, this bot is perfect reminder for you,
it pings the author of the pull request when there are changes in the base branch, see the following snapshot:
## Setup
```sh
# Install dependencies
npm install
# Run the bot
npm start
```
## Contributing
If you have suggestions for how pr-base-reminder could be improved, or want to report a bug, open an issue! We'd love all and any contributions.
For more, check out the [Contributing Guide](CONTRIBUTING.md).
## Big Thanks
[Xincen](https://github.com/chiyokei) to provide the icon for this bot.
## License
[ISC](LICENSE) © 2020 Xavier Zhou