From d1026edf3fb40dfd608128295fb1e5e9f84ec4e3 Mon Sep 17 00:00:00 2001 From: Les Aker <50016312+akerl-unpriv@users.noreply.github.com> Date: Fri, 5 Jul 2019 15:21:55 +0100 Subject: [PATCH] Update README.md (#98) When using policybot with a custom server, I initially expected the behavior described to be: * The custom path is checked * If the custom path does not exist, the default path is checked In actuality, if a custom path is configured, *only* the custom path is checked. This update attempts to call that out more clearly. --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3732cfb7..b7d3ef29 100644 --- a/README.md +++ b/README.md @@ -39,8 +39,9 @@ UI to view the detailed approval status of any pull request. ## Configuration By default, the behavior of the bot is configured by a `.policy.yml` file at -the root of the repository. The file name and location are configurable when -running your own instance of the server. +the root of the repository. When running your own instance of the server, a +different file name and location can be configured. The configured name and +location will be used instead of the default location. - If the file does not exist, the `policy-bot` status check is not posted. This means it is safe to enable `policy-bot` on all repositories in an organization.