Merge pull request #34 from probot/app-to-plugin

plugin -> app
This commit is contained in:
Brandon Keepers
2017-08-24 15:15:38 -05:00
committed by GitHub
3 changed files with 6 additions and 6 deletions

View File

@@ -36,9 +36,9 @@ Work in Progress pull request are also welcome to get feedback early on, or if t
## Adding your app
You can add your plugin by adding it as `_apps/your-plugin-name.md`
You can add your app by adding it as `_apps/your-app-name.md`
Here are the things you need to include about your plugin:
Here are the things you need to include about your app:
```
---
@@ -53,7 +53,7 @@ repository: where your code is located (ie behaviorbot/welcome)
# All other stats fields you see on the website, will be grabbed as real data, such as organizations, installations, and stars.
---
Any documentation can go here. Many plugins just use their README.md here.
Any documentation can go here. Many apps just use their README.md here.
```
@@ -64,7 +64,7 @@ We will list un-hosted apps on the website to help gain more exposure. We will c
When considering hosting new plugins here's what we look for, the app:
- Works (ie it can run without errors and perform some sort of action on GitHub through the API)
- Does something not already done by an existing probot plugin
- Does something not already done by an existing probot app
- Has minimal tests
- Has minimal documentation
- Is open source

View File

@@ -6,7 +6,7 @@ This is the home of probot.github.io, a website for [probot](https://github.com/
The majority of documentation on the site is drawn from [the probot docs](https://github.com/probot/probot/blob/master/docs/). If you have requests for documentation additions to probot, please open an issue in [probot/probot](https://github.com/probot/probot), or if you want to add them yourself, feel free to open a pull request there.
## Plugin Showcase
## App Showcase
We also use this website to show off some of the cool probot plugins built by the community. If you would like to have your plugin listed there, check out our [Contributing Guidelines](https://github.com/probot/probot.github.io/blob/master/CONTRIBUTING.md) for more information about what the requirements are to do that.

View File

@@ -17,7 +17,7 @@ You can tell from this example just how toxic I am 😜
## Usage
1. Install the bot on the intended repositories. The plugin requires the following **Permissions and Events**:
1. Install the bot on the intended repositories. The app requires the following **Permissions and Events**:
- Issues: **Read & Write**
- **Issue Comment** events
2. Add a `.github/config.yml` file that contains the following: