https://github.com/rsarky/pro-claim
GitHub App that assigns contributors to issues when they "claim" them in the comments.
https://github.com/rsarky/pro-claim
github-app issues probot probot-app
Last synced: 2 months ago
JSON representation
GitHub App that assigns contributors to issues when they "claim" them in the comments.
- Host: GitHub
- URL: https://github.com/rsarky/pro-claim
- Owner: rsarky
- License: isc
- Created: 2018-02-24T18:04:49.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-03-12T19:29:12.000Z (over 8 years ago)
- Last Synced: 2025-12-26T20:57:36.485Z (6 months ago)
- Topics: github-app, issues, probot, probot-app
- Language: JavaScript
- Homepage:
- Size: 419 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# pro-claim
> A GitHub App built with [probot](https://github.com/probot/probot) that automatically assigns a contributor to an issue that he/she 'claims' for. Inspired by [zulipbot](https://github.com/zulip/zulipbot)
Useful for open source organizations who want to allow aspiring contributors to claim issues in a democratic and straightforward manner.
***Only works for repositories owned by organizations.***
## Usage
Install pro-claim on your repository. For any aspiring contributor to claim an issue he/she must comment :
>@pro-claim claim
This will assign the user to the issue.
### NOTE
* Only one assignee per issue is allowed.
* First time contributors need to accept an invite that makes them a read only collaborator so that they can be assigned issues.
## Screenshots
If user is a new contributor :
![new-contributor][]
Assigning issues :
![Assigning-issues][]
If Issue already has an assignee:
![Preassigned][]
[Assigning-issues]: ./screenshots/assign-issue.png
[Preassigned]: ./screenshots/issue-already-assigned.png
[new-contributor]: ./screenshots/new-contributor.png
## Todo
- [ ] Add templates with appropriate messages.
- [ ] First time contributor message. (Accept invite.)
- [ ] Issue Assigned message.
- [ ] Issue Unassigned message.
- [ ] Issue already assigned message.
- [ ] Unassign after inactivity message.
- [ ] Add tests.
- [ ] Unassign assignee after a period of inactivity.
- [ ] Only assign to issues with certain labels ( good-first-issue/first-timers-only/help-wanted)
- [ ] Add a configuration file with the necessary fields.
## Setup
```
# Install dependencies
npm install
# Run the bot
npm start
```
See [docs/deploy.md](docs/deploy.md) if you would like to run your own instance of this app.