🔓Public Solver Quests

Public Quests are visible on GitHub. You will find them in some open source repositories and they will look like this.

Solver quests can reward you with badges, swag, cash, and more! Sometimes the bot will tell about the reward underneath, but some other times it will be a surprise for the contributor that merges the issue.

---

1️⃣ Embarking on a Quest

If you want to attempt solving an issue, just comment @quest-bot embark on GitHub. This will check you into the quest and let other people know you're interested in solving the issue.

In theory, if the Quest is open and public, anyone can tackle it, regardless of how many people have called embark or loot on it! However, please always check the internal rules of the repository in question, such as CONTRIBUTING.md or README.md file to see whether there are any community-specific rules here.

---

2️⃣ Looting a Quest with a PR

Once you have embarked, go and work on your Pull-Request. When you are ready to submit it, signal to maintainers that you are ready to claim your reward for looting the Quest.

You can do this one of two ways:

a) Looting a Quest from GitHub with the help from @quest-bot

You can let @quest-bot know that your PR targets a specific Quest by commenting in the first or last line of the PR body when raising the PR, or in a separate comment on the PR to follow:

@quest-bot loot #{issue_number}

Note the loot command must declare the Quest Issue that the Pull Request is addressing, referring to the appropriate Issue using it's number in GitHub prepended by a hash symbol (#).

[Special case] Looting multiple Quests from a single PR

In some cases you may be interested in addressing multiple Quest Issues from an organisation through a single Pull Request that resolves them all. You can do this by chaining Issue references in the loot command when you raise your PR (simply including a space between each reference).

For example, if you are looking to loot three Issues, the syntax becomes:

@quest-bot loot #{issue_num_1} #{issue_num_2} #{issue_num_3}

[Special case] Looting when the Issue and PR reside in different repos

In some rare cases you may be required to loot a Quest Issue that resides in a different repo to the one where your PR is raised. This can occur if, for example, an Issue is raised in one repo but the solution relates to code in another repo. To do this the loot command must include a path reference, with the appropriate Issue prepended by its repo name. For example:

@quest-bot loot {repo_name}/#{issue_number}

The above format can also be chained for looting multiple Issues (with or without respective repo paths per Issue reference accordingly).

b) Looting a Quest via the Quira website

If you have access to the Solver Quest dashboard, after you raise your PR on GitHub, copy the URL to the PR page, then head back over to Quira and click through from your Solver dashboard to the relevant Quest you want to loot for a reward.

The Submit PR button

Click the Loot this Quest with a PR button and follow on-screen instructions (pasting in your URL from GitHub). This will automatically raise a loot command on GitHub and let other Solvers know you are seeking a reward.

The Submit PR screen

---

3️⃣ Getting rewarded

The maintainers will issue a reward if:

1. Your PR is successfully merged,

2. The PR actually solves the Issue where the quest is located.

When a reward has been awarded you will be notified on the comment thread of the related Issue and you will also see a banner in your solver dashboard at Quests -> Solvers that includes the total value of any unclaimed rewards on your account.

💸 For instructions on how to claim your rewards, go here!