Quira Docs
  • 📃Quira docs
  • For Developers
    • 🛠️Getting set up
      • 1️⃣Sign up with GitHub
      • 2️⃣Verify your email
      • 3️⃣Set up your profile
      • ⚙️Account management
    • Creator Quests
      • Creator Quests standard rules
    • Solver Quests
      • 👐Public Solver Quests
      • 🔐Private Solver Quests
    • 💸Claiming rewards
  • For Organisations
    • 🛠️Getting set up
    • Creator Quests
    • Solver Quests
      • Public Solver Quests
      • Configuring Solver Quests
      • Abort or edit a quest
      • Common errors with @quest-bot
  • Get in touch
    • 📞Contact us
Powered by GitBook
On this page
  1. For Developers
  2. Solver Quests

Public Solver Quests

PreviousSolver QuestsNextPrivate Solver Quests

Last updated 1 month ago

Public Solver Quests are visible visible in the comment thread of the corresponding GitHub issue. GitHub. You will find them in some open source repositories and they will look like this. If the maintainer has enabled this option, these bounties will also appear in the Solve tab of the app.

Here's the full workflow for Solver Quests.

1

Find the quest you'd like to work on

You can find some public quests to work on in the Solver tab of the app. In some cases, the quests won't be indexed in the app, but you will see them displayed in the issue comment threads of repositories using Quira.

2

Embark on the Quest

Once you've found a quest, you can check into it by commenting

@quest-bot embark

on the issue comment thread. Embarking on the quest will display a public message to let the community know that you're working on it.

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.

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.

3

(Option 1) Loot the Quest with a PR via @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}

For example, @quest-bot loot #23 loots quest on issue #23.

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).

@quest-bot loot #{issue_num_1} #{issue_num_2} ... #{issue_num_n}

For example, @quest-bot loot #23 #454 #1112 loots quests on issues #23, #454 and #1112 .

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.

@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).

4

(Option 2) Loot the Quest with a PR via the Quira app

You can also submit your PR on GitHub and claim loot through the Quira app. Simply copy the PR URL, navigate to the quest you're working on, and click the "Loot this Quest with a PR" button.

Then just paste in your PR URL from GitHub and click on the Submit button. This will automatically raise a loot command on GitHub and let other Solvers know you are seeking a reward.

5

Work on your revisions and claim your reward

The maintainers will issue a reward if your PR is successfully merged. When a reward has been issued you will see it in your Quira wallet.

To cash out, click on it and follow the instructions. More information in Claiming rewards

👐
✨
The Submit PR button
The Submit PR screen