Skip to content

Commit

Permalink
Correct default org repo documentation
Browse files Browse the repository at this point in the history
* Closes github#263
  • Loading branch information
JoshuaTheMiller committed Jan 25, 2022
1 parent e615095 commit 74629b2
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,8 +161,9 @@ Once you have the **GitHub App** up and running, users will need to add the conf
- Having this file in the root of the repository is what signals the **Rally + GitHub App** to view all configured events for the repository
- The configuration file allows users to make small customizations to how the bot interacts with their codebase
- Users will also want to configure `protected branches` to help make sure all rules are followed and enforced by the validator bot
- If a default configuration for all repositories in an organization is desirable, create a `.github/rally.yml` file in a repository called `[ORG_NAME]/rally-github-config`. The name of this configuration repository can also be set as an environment variable.
- If a _per_-repository configuration needs to be managed from a central repository, create a `.github/rally/[REPO_NAME].yml` file in a repository called `[ORG_NAME]/rally-github-config` instead.
- If a default configuration for all repositories in an organization is desirable, create a `rally.yml` file in a repository called `[ORG_NAME]/.github`.
- The name of this configuration repository can also be set as an environment variable (i.e., this bot can look in a repository other than `[ORG_NAME]/.github`).
- Additionally, if a _per_-repository configuration needs to be managed from this central configuration repository, create such configuration files in a folder named `rally` (e.g., `rally/[REPO_NAME].yml`).

## How to contribute
We invite you to contribute to this **GitHub App**! Check out [Issues](https://github.com/github/rally/issues) (especially those labeled `help wanted` or `good first issue`) and jump over to [CONTRIBUTING](https://github.com/github/rally/blob/main/.github/CONTRIBUTING.md) for more details.
Expand Down

0 comments on commit 74629b2

Please sign in to comment.