🔓Public Solver Quests

To take part in a Public Quest click the invite link you received and then follow these instructions:

1️⃣ Getting started

From your invite link you will be taken to a specific Quest Issue page, listing details about the Issue and associated Quest. Read about the Quest and decide whether you want to attempt to solve it.

Note, if you have unlocked access and been matched to specific Solver Quests that we think would suit your skillset, you will see also see the Quest listed alongside all other active Quest Issues that you can take part in on the Quests -> Solvers tab on Quine. Public Quests are marked with a corresponding green public label.

2️⃣ Embarking on a Quest

When you are ready to get started click the Embark button and follow on-screen instructions. From here you will be linked through to GitHub to get started on the Issue.

Check out @quest-bot's comments on the Issue thread on GitHub to find out the status of the Quest and whether anyone else has already tried to solve it ('embarking' on it indicates an intention to solve, whilst 'looting' a Quest indicates that a PR has been raised). You should also see your own embark announcement on the Issue thread.

If the Quest is open and public, anyone can tackle it, regardless of how many people have called embark or loot on it! 👀

3️⃣ Looting a Quest with a PR

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 with 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 cases to consider when looting multiple Quests, or where a PR and Issue reside in different repositories

Looting multiple Quests from a single PR:

Note, in some rare 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}

Looting a Quest when an Issue and Pull Request reside in different repositories:

Note, 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 Quine website

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

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.

4️⃣ Getting rewarded

The maintainers will issue a reward if:

  1. Your PR is successfully merged,

  2. The PR actually solves the Issue.

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 https://quine.sh/my-quests that includes the total value of any unclaimed rewards on your account.

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

Last updated