Files
probot.github.io/_apps/invite-contributors.md
Brandon Keepers f163dbc446 Sync data
2017-12-08 18:27:45 +00:00

43 lines
1.8 KiB
Markdown

---
title: invite-contributors
description: Invite authors of merged pull requests to your organization
slug: invite-contributors
screenshots:
- https://i.imgur.com/USwS3CF.png
authors:
- erickzhao
repository: erickzhao/invite-contributors
stars: 8
updated: 2017-11-06 05:29:49 UTC
host: https://vast-stream-78160.herokuapp.com
installations: 8
organizations:
- cla-assistant
- flyve-mdm
- aethonanbot
- aVengineers
- chaijs
- elodiebot
- dddpppmmm
---
# invite-contributors
[![Build Status](https://api.travis-ci.org/erickzhao/invite-contributors.svg?branch=master)](https://travis-ci.org/erickzhao/invite-contributors) [![codecov](https://codecov.io/gh/erickzhao/invite-contributors/branch/master/graph/badge.svg)](https://codecov.io/gh/erickzhao/invite-contributors)
**invite-contributors** is a GitHub App built with [probot](https://github.com/probot/probot) that automatically invites new contributors to your repository's organization once they get a Pull Request merged.
## Usage
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.*
```
# team name
team: MY TEAM NAME
```
## Contributing
Anyone can contribute with [issues](https://github.com/erickzhao/invite-contributors/issues) and [PRs](https://github.com/erickzhao/invite-contributors/pulls). If you're submitting a pull request, always create a new branch to work your changes, and try squashing commits down if possible. Always test any new code and make sure `npm test` passes and code coverage is adequate before opening a PR.