Merge pull request #121 from erickzhao/invite-contributors

Update invite-contributors README to reflect update
This commit is contained in:
Brandon Keepers
2018-01-26 09:06:00 -05:00
committed by GitHub

View File

@@ -3,7 +3,7 @@ title: invite-contributors
description: Invite authors of merged pull requests to your organization
slug: invite-contributors
screenshots:
- https://i.imgur.com/USwS3CF.png
- https://i.imgur.com/IoTF1aD.png
authors:
- erickzhao
repository: erickzhao/invite-contributors
@@ -32,9 +32,17 @@ organizations:
1. Configure the GitHub App.
2. invite-contributors will automatically invite new users who have their pull requests merged to your organization.
3. If you want to add new contributors to a specific team in your organization, add a `.github/invite-contributors.yml` file into your repository such as below. *Note that entering the team name and team slug are both valid formats.*
3. More options are available if you add a `.github/invite-contributors.yml` file into your repository such as below.
```
# team name
# If true, this will add new contributors as outside collaborators
# to the repo their PR was merged in. Team name is ignored if this
# flag is set to true.
isOutside: false
# Specify team name to add new contributors to a specific team
# within your organization.
# Use team name or team-name-slug
team: MY TEAM NAME
```