Developer submits a PR

When a developer has created a Pull Request to solve an Issue associated with a Quest, they can link their PR to the relevant Issue (and its stashed reward) via the Quira website, using a GitHub URL to their PR.

Alternatively, for public Quests only, a developer can use the loot command on GitHub.

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

The loot command can either be called in the PR body comment when raising the PR (in its first of last line), or in a comment on the PR to follow. The loot command should declare the Issue number that the Pull Request is addressing, referring to the appropriate Issue using it's number in GitHub prepended by a hash symbol, in the form: #{issue_number}. If multiple Quest Issues are being looted under a single PR, they should be separated by a space in the respective comment, and must not include commas or other symbols.

For example, if the developer is looting one Issue (Quest) the formula is:

@quest-bot loot #{issue_number}

If the developer is looting three Issues, the syntax becomes:

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

Note, it is also possible for a developer to loot a Quest in a different repository than the repo where the relevant PR resides. 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 as per other loot commands.

For a successful loot, a message like this will appear on the Pull Request:

@{looter}, you have made a valiant attempt to loot this reward ðŸĪš

...

And a corresponding message with appear on the related Issue(s) itself, notifying all other members that the Quest is being looted.

Click here for common errors with loot.

Last updated