xxq250
/
probot
forked from mirrors/probot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add 'dry run' recommendation

This commit is contained in:
Lee Dohm 2017-04-03 15:29:36 -07:00
parent 03193ad44e
commit 8843f6f21e
No known key found for this signature in database
GPG Key ID: A27E146D71F5F6B6
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/best-practices.md
View File

@ -8,6 +8,12 @@ Being installed on an account is sufficient permission for actions in response t
For example, the [stale](https://github.com/probot/stale) plugin will only scan a repository for stale issues and pull requests if `.github/stale.yml` exists in the repository.
### Include "dry run" functionality
A dry run is when a plugin, instead of actually taking an action, only logs what actions it would have taken if it wasn't a dry run. A plugin _must_ offer a dry run feature if it does anything destructive and _should_ offer a dry run feature in all cases.
For example, the [stale](https://github.com/probot/stale) plugin will perform a dry run if there is no `.github/stale.yml` file in the repository.
## Configuration
### Require minimal configuration