Skip to content

docs: add GitHub issue scraper bounty design #1399

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mdan5678-dotcom wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add GitHub issue scraper bounty design #1399

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -484,3 +484,8 @@ MIT
<p align="center">
Built with 🔥 by the SolFoundry automaton
</p>

<!-- bountyops-package-note -->
## GitHub issue scraper for Foundry bounties

Design notes are available in [`docs/github-issue-scraper-bounty-design.md`](docs/github-issue-scraper-bounty-design.md).
32 changes: 32 additions & 0 deletions docs/github-issue-scraper-bounty-design.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# GitHub issue scraper for Foundry bounties

This document outlines an implementation plan for automatically discovering GitHub issues and turning eligible issues into SolFoundry bounty candidates.

## Workflow

1. Load configured GitHub repositories.
2. Poll open issues through the GitHub API.
3. Normalize issue metadata into a common bounty candidate format.
4. Score each candidate for bounty suitability.
5. Map score and labels to a reward tier.
6. Store candidates with stable dedupe keys.
7. Hold risky or unclear candidates for manual review.
8. Post approved candidates to SolFoundry only after policy checks pass.

## Candidate metadata

Each candidate should preserve repository, issue number, title, body summary, labels, URL, timestamps, detected domain, estimated difficulty, suggested tier, posting status, and dedupe key.

## Safety checks

The scraper should reject hidden-prompt requests, payout or wallet instructions, unclear acceptance criteria, duplicate source URLs, and security-sensitive exploit detail.

## Testing checklist

- Polling returns normalized candidates.
- Closed issues are not posted as new bounties.
- Duplicate GitHub issues do not create duplicate bounty records.
- Webhook retries are idempotent.
- Unsafe issues are held for manual review.
- Reward tier mapping is deterministic.
- API failures use bounded retry behavior.