Skip to content

GitHub App that assigns contributors to issues when they "claim" them in the comments.

License

Notifications You must be signed in to change notification settings

rsarky/pro-claim

Repository files navigation

pro-claim

A GitHub App built with probot that automatically assigns a contributor to an issue that he/she 'claims' for. Inspired by 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

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 if you would like to run your own instance of this app.

About

GitHub App that assigns contributors to issues when they "claim" them in the comments.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published