mirror of
https://github.com/zhigang1992/probot.github.io.git
synced 2026-01-12 17:33:05 +08:00
add documented app review process
This commit is contained in:
20
.github/PULL_REQUEST_TEMPLATE.md
vendored
20
.github/PULL_REQUEST_TEMPLATE.md
vendored
@@ -3,18 +3,20 @@ Thank you for your pull request. Please provide a description above and review
|
||||
the requirements below.
|
||||
|
||||
Contributors guide: https://github.com/probot/probot.github.io/blob/master/CONTRIBUTING.md
|
||||
|
||||
App Review Process: https://github.com/probot/probot.github.io/blob/master/.github/app-review-process.md
|
||||
-->
|
||||
|
||||
##### Checklist
|
||||
<!-- Be sure to provide links for relevant sections, ie link to your License. For completed items, change [ ] to [x]. -->
|
||||
<!-- Be sure to replace yourURLhere for relevant links. Additionally, update anything in {braces}. For completed items, change [ ] to [x]. -->
|
||||
|
||||
- [ ] If you're adding a listing for your app, be sure your app is in the `/_apps/` folder before opening this Pull Request.
|
||||
- [ ] All comments in frontmatter need to be removed.
|
||||
- [ ] Performs a useful action through the GitHub API that solves an existing problem for developers
|
||||
- [ ] Is original: for example, it does something not already done by an existing probot app
|
||||
- [ ] Has tests
|
||||
- [ ] Has documentation
|
||||
- [ ] Is open source
|
||||
- [ ] Has a license
|
||||
- [ ] Has a code of conduct
|
||||
- [ ] Has someone willing to at least minimally maintain them for the near future
|
||||
- [ ] Performs a useful action through the GitHub API that solves an existing problem for developers: {explain the action here}
|
||||
- [ ] Is original: for example, it does something not already done by an existing Probot app
|
||||
- [ ] Has tests: [My Tests](yourURLhere)
|
||||
- [ ] Has documentation: [My Docs](yourURLhere)
|
||||
- [ ] Is open source: [My Repo](yourURLhere)
|
||||
- [ ] Has a license: [My License](yourURLhere)
|
||||
- [ ] Has a code of conduct: [My CoC](yourURLhere)
|
||||
- [ ] Has someone willing to at least minimally maintain them for the near future: {your maintainer's name}
|
||||
|
||||
18
.github/app-review-process.md
vendored
Normal file
18
.github/app-review-process.md
vendored
Normal file
@@ -0,0 +1,18 @@
|
||||
# App Review process
|
||||
|
||||
We want to be as transparent as possible about the process an app goes through in order to be listed on the website. When a maintainer merges or does not merge an app on the website, it will be a result of the criteria below.
|
||||
|
||||
These are essentially the steps we take to verify apps before listing them:
|
||||
|
||||
- [ ] Ensure all fields in the pull request template have been checked and links are included.
|
||||
- [ ] Verify the legitimacy of each link.
|
||||
- [ ] Open each of the screenshots to ensure they show the specific app functionality as clearly as possible.
|
||||
- [ ]Install the app on a test organization
|
||||
and ensure the app works as advertised.
|
||||
- [ ] Check all links in description of app: looking mostly for relative references since folks usually copy from their readme.
|
||||
- [ ] Confirm the app slug is associated with the app.
|
||||
- [ ] Check for any written references to being a Probot/GitHub app to avoid feeling repetitive since they're on the website.
|
||||
- [ ] Think about the app's usecase and usefulness to developers. This often becomes a discussion amongst the maintainers in private channels if there's concerns that the app doesn't provide tangible benefits.
|
||||
- [ ] Read the entire description/how the app works to make sure someone new could figure it out.
|
||||
|
||||
And if the app passes all of these checks, it will be merged in!
|
||||
@@ -82,6 +82,7 @@ Any documentation can go here. Many apps just use their README.md here.
|
||||
- Has a code of conduct
|
||||
- Has someone willing to at least minimally maintain them for the near future
|
||||
|
||||
The app will then go through a review process before being listed on the website. You can check out the [app review process here](https://github.com/probot/probot.github.io/blob/master/.github/app-review-process.md).
|
||||
|
||||
## Apps
|
||||
|
||||
@@ -90,4 +91,3 @@ We have one app enabled on this repo:
|
||||
- [Stale](https://probot.github.io/apps/stale/): We use Stale to ensure that conversations here remain relevant. This is for us, the maintainers, so that we don't feel like we've got hundreds of issues to deal with; if you still have an issue, please let us know! We don't want to close issues that are painful for you. Stale just helps us have a bit more breathing space by making sure issues don't pile up forever.
|
||||
|
||||
If you're concerned about our apps or feel that they are insensitive in some way, please let us know.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user