From 83a151a721cc160aaf2f7046dcbdf6f5cdca6add Mon Sep 17 00:00:00 2001 From: erick Date: Sun, 22 Oct 2017 17:23:34 -0400 Subject: [PATCH] Update invite-contributors README I fixed some mistakes regarding how to use my .yml and added a test coverage badge. :) --- _apps/invite-contributors.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/_apps/invite-contributors.md b/_apps/invite-contributors.md index e374828..3d1a034 100644 --- a/_apps/invite-contributors.md +++ b/_apps/invite-contributors.md @@ -13,20 +13,20 @@ updated: 2017-10-21 22:18:19 UTC # invite-contributors -[![Build Status](https://travis-ci.org/erickzhao/badge.svg?branch=master)](https://travis-ci.org/erickzhao/badge) +[![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, giving them a *badge* to wear on their profile. +**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/badge.yml` file into your repository such as below. Note that entering the team name and team slug are both valid formats. +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 -MY 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 before opening a PR. +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.