A GitHub App built with Probot that helps maintainers by automatically assigning willing contributors to issues! 🎉
Step 1 👨💻 - A willing user comments on an issue with phrases like "Please assign me" or "I'd like to work on this"
Step 2 🤖 - The bot will automatically recognize the comment and assign the commenter!
Alternatively - You can try configuring the bot to recognize @mentions in comments and assign users accordingly!
- Simply go to the app listing and click the install button
- Choose your account & repository, and install the app!
- Optionally, you can provide a
.github/claimsy.ymlin your repo to customize some features of the app
Here's a sample .github/claimsy.yml to let you know how to tell Claimsy what comments to look for -
# Commands to allow contributors to get issues assigned to themselves
selfAssignCommands:
- I'll do it
- May I do it
# A flag value to allow anyone to assign anyone to an issue. This is currently experimental so use it at your own risk!
allowUserAssignments: false
# Commands to allow anyone to assign issues to anyone, including themselves
assignCommands:
- assign this to USERNAME
- will be done by USERNAME
# Remember to put in the term USERNAME as a placeholder for the @mentions that will be made in commentsNote:
To handle a comment such as 'assign this issue to @krharsh17', make sure to include 'assign this issue to USERNAME' in your
assignCommandslist. The keyword USERNAME is mandatory and to be used as is for placeholder of @mentions
- Clone the repo
- Make sure to have Node installed on your system
- Run the following commands in a terminal inside the cloned repo:
# Install dependencies
npm install
# Run the bot
npm startIf you have suggestions for how Claimsy could be improved, or want to report a bug, open an issue! We'd love all and any contributions.
For more, check out the Contributing Guide.
ISC © 2020 krharsh17 [email protected]