https://github.com/erickzhao/invite-contributors

:octocat: automatically invite authors of merged pull requests to your organization
https://github.com/erickzhao/invite-contributors

bot github nodejs organization probot utility

Last synced: about 2 months ago
JSON representation

:octocat: automatically invite authors of merged pull requests to your organization

• Host: GitHub
• URL: https://github.com/erickzhao/invite-contributors
• Owner: erickzhao
• License: isc
• Archived: true
• Created: 2017-10-06T01:24:05.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2018-05-05T14:10:11.000Z (over 6 years ago)
• Last Synced: 2024-09-22T13:02:10.075Z (about 2 months ago)
• Topics: bot, github, nodejs, organization, probot, utility
• Language: JavaScript
• Homepage: https://probot.github.io/apps/invite-contributors/
• Size: 223 KB
• Stars: 35
• Watchers: 4
• Forks: 12
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-list - invite-contributors

README

        
# 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. More options are available if you add a `.github/invite-contributors.yml` file into your repository such as below.

```

# 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

```

## 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.