Public Solver Quests

Solver Quests provide organisations with a simple way to create bounties on their open GitHub Issues. They allow you to create customisable issue bounties on top of any of your public GitHub issues, giving you complete control over the contributor experience. Here's how you can create a Solver Quest:

1

Pre-requisites

1. Getting set up

2. (Optional) Configuring Solver Quests

2

Start a new Public Solver Quest

There are two ways to start a new Quest

Via your Admin Dashboard

To start a quest via the Admin Dashboard just click on the Start Quest button and follow the instructions. If you want to create private quests or reward them with swag, please follow the instructions in .

Via @quest-bot

Use @quest-bot to create public quests that are rewarded by cash and digital badges. A registered member of your organisation can initiate a quest by "stashing" a USD reward of reward_value in a GitHub Issue. To start a quest just comment this formula on the underlying GitHub issue.

@quest-bot stash {reward_value}

For example,

Creating a $100 Solver Quest on an issue

Note that there is no currency symbol used in the above command. For now, all integer values are taken as USD by default. If the command was successful the bot will reply with a confirmation message.

To abort the quest or change the value of the reward go to Abort or edit a quest. For help troubleshooting go to Common errors with @quest-bot

3

Developer works on the PR and loots the quest

A developer can express interest in solving it by "embarking" on the Quest. Developer will embark by commenting

@quest-bot embark

on the Issue's comment thread. Embarking on a Quest does not provide the developer with exclusivity, but it lets the organisation and other solvers know that they intend to solve it.

When a developer has created a Pull Request to solve the issue, they can link their PR to the relevant quest by invoking the loot command.

@quest-bot loot #{issue_number}

The loot command can be invoked at any point in the Pull Request lifecycle, but we recommend calling it immediately upon submitting a PR.

You can learn more about how developers experience embarking & looting in Public Solver Quests.

4

Get the PR merged & issue the reward

When a PR has been merged, the organisation must explicitly accept loot claims associated with the Issue. There are two ways to do this

Via your Admin Dashboard

Go to your admin dashboard and click on the quest you want to reward to see the quest's event stream. For a Quest to be considered solved, there must be at least one PR Merged event for one of the submissions (loots).

If a PR Merged event exists you can directly award the winner their reward by pressing this button Award Solver.

Via @quest-bot

To issue rewards via @quest-bot just use the reward command in the Issue's thread where the quest was initially created.

@quest-bot reward @{username}

A confirmation message congratulating @{username} will be commented by @quest-bot.

The Quest reward will automatically be issued to the user that raised the PR (and looted), and @quest-bot will notify other participants that the quest is over. Rewarding the solver will also mark this quest as Closed.

5

(Optional) Tip the developer

As well as rewarding a developer for a successful merge you can send any developers participating in the quest additional rewards through the tip command. All tips are assumed to be a USD amount of tip_value directed to a specific GitHub user using a command in the format:

@quest-bot tip @{username} {tip_value}

Note there is no currency symbol used in the above command. For now, all integer values are taken as USD by default.

Note that this feature is not available via the Admin Dashboard.