kylefang/probot.github.io
1
0
Fork 0
mirror of https://github.com/zhigang1992/probot.github.io.git synced 2026-01-12 22:49:53 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #78 from erickzhao/patch-1

Browse Source 
Add invite-contributors to list of apps
This commit is contained in:
Brandon Keepers
2017-10-19 08:40:21 -05:00
committed by GitHub
parent 91093bd010 ae28d81e83
commit f7be0c3c39
1 changed files with 35 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
_apps/invite-contributors.md Normal file
View File

@@ -0,0 +1,35 @@
---
# A human-friendly name of your listing
title: invite-contributors
# A short description of what your app does
description: Automatically invite authors of merged pull requests to your organization
# The slug of your hosted app on GitHub (https://github.com/apps/YOUR-SLUG)
slug: https://github.com/apps/invite-contributors
# Include a few screenshots that show your app in action
screenshots:
- https://i.imgur.com/USwS3CF.png
# The GitHub usernames of anyone who authored the app
authors: [ erickzhao ]
# The repository where the code is located
repository: erickzhao/invite-contributors
---
# invite-contributors
[![Build Status](https://travis-ci.org/erickzhao/badge.svg?branch=master)](https://travis-ci.org/erickzhao/badge)
**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, giving them a *badge* to wear on their profile.
## 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/badge.yml` file into your repository such as below. Note that entering the team name and team slug are both valid formats.
```
# team name
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 before opening a PR.