probot/README.md

26 lines
1.7 KiB
Markdown
Raw Normal View History

2017-03-12 23:48:09 +08:00
# Probot
2016-09-17 00:06:46 +08:00
2017-03-28 04:06:04 +08:00
Probot is a bot framework for GitHub. It's like [Hubot](https://hubot.github.com/), but for GitHub instead of chat.
2016-09-17 06:00:20 +08:00
2017-03-14 11:26:59 +08:00
If you've ever thought, "wouldn't it be cool if GitHub could…"; imma stop you right there. Most features can actually be added via [GitHub Integrations](https://developer.github.com/early-access/integrations/):
2017-03-12 12:50:33 +08:00
2017-03-14 11:26:59 +08:00
> Integrations are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. Integrations are first class actors within GitHub.
>
> Documentation on [GitHub Integrations](https://developer.github.com/early-access/integrations/)
2016-09-18 02:31:24 +08:00
2017-03-20 12:01:03 +08:00
There are some great services that offer [hosted integrations](https://github.com/integrations), but you can build a bunch of really cool things yourself. Probot aims to make that easy.
2016-09-17 00:06:46 +08:00
2017-03-20 12:01:03 +08:00
## Plugins
2016-09-17 00:06:46 +08:00
2017-03-20 12:01:03 +08:00
Bots are implemented as plugins, which are easy to write, deploy, and share. Here are just a few examples of things probot can do:
2017-03-20 12:01:03 +08:00
- [stale](https://github.com/probot/stale) - closes abandoned issues after a period of inactivity.
- [owners](https://github.com/probot/owners) - @mentions people in Pull Requests based on contents of the OWNERS file
- [configurer](https://github.com/probot/configurer) - syncs repository settings defined in `.github/config.yml` to GitHub, enabling Pull Requests for repository settings.
2017-03-20 12:01:03 +08:00
Check out [all probot plugins](https://github.com/search?q=topic%3Aprobot-plugin&type=Repositories).
2017-03-20 12:01:03 +08:00
## Contributing
2016-10-13 11:24:48 +08:00
2017-03-20 12:01:03 +08:00
Most of the interesting things are built with plugins, so consider starting by [writing a new plugin](docs/plugins.md) or improving one of the [existing ones](https://github.com/search?q=topic%3Aprobot-plugin&type=Repositories).