Unless otherwise discussed, this repo will be made public after audit completion, sponsor review, judging, and issue mitigation window.
Contributors to this repo: prior to report publication, please review the Agreements & Disclosures issue.
To view your assigned issues, use the Assignee
filter on the Issues screen, and type your username to locate it. This should produce a filtered issue list that you can reference throughout the validation process.
When a validator has been assigned to an issue, they have four different actions they can take.
Each of these is performed by typing a command into the issue's comments and sending it. Each
command must be prefixed by the trigger
phrase the bot was configured for. In production, this
is @howlbot
and the remainder of this document will assume that value for simplicity, though it
may be different in different environments.
@howlbot accept [comment]
Accepts an issue as valid and forwards it to the corresponding -findings
repository. If an
optional comment is provided, the bot will add a comment to the new issue in the findings repo.
sufficient quality report
-findings
repositoryvalidatedIssueId
and validatedIssueUrl
fields pointing to the newly created issue-validation
repository-findings
repository with originalIssueId
and originalIssueUrl
fields pointing to the issue in the -validation
repository@howlbot reject [comment]
Rejects an issue. If an optional comment is provided, the bot will add it to the issue.
insufficient quality report
@howlbot claim
Claims an issue.
The issue in question must:
unknown
label attached to itThe user sending the command must:
unknown
issue assignmentsIf the above criteria are all met, then the issue will be assigned to the user.
@howlbot skip
Allows a validator to flag an issue as having not been reviewed, while allowing them to move on to a different issue.
unknown
@howlbot undo <accept|reject>
Undoes either an accept
or reject
action by reversing the steps they normally take and reopening the issue.
@howlbot edit
Allows a validator to modify the contents of a submission.
This command accepts a parameter in the form of the new content for the submission, to use it:
@howlbot edit
this is where my new submission content would go. this will replace the current content of the issue
as well as adding a label to the issue, but it will not automatically accept it, you'll still have
to do that separately
improved
After a validator has completed, or skipped, an issue they will be automatically assigned one new
issue. If the issue had been previously marked as unknown
and is either accepted or rejected, a
bonus of three additional issues is included and the validator will receive a total of four new
assignments.
Since the GitHub UI will allow validators to perform some actions outside of howlbot, such as closing, assigning or unassigning an issue, some of these are monitored and will be acted on as though the validator performed an action implicitly.
If an issue is:
active
topicthe issue will be marked as though the validator ran @howlbot reject
If an issue is:
and the assignee does not currently have another previously skipped issue assigned, then the assignment is allowed to stand and the validator is permitted to claim the issue as their own.
If the above criteria are not all met, the assignment will be reversed.
If an issue is:
active
topicthe issue will be treated as though the validator ran @howlbot skip
if the unassignment was performed by someone other than the assignee, the action will be reversed and the original assignee restored.