Skip to content

docs(tutorial): Getting Started with SolFoundry guide (closes #830)#1371

Open
akuraposo wants to merge 1 commit into
SolFoundry:mainfrom
akuraposo:docs/bounty-830-getting-started-tutorial
Open

docs(tutorial): Getting Started with SolFoundry guide (closes #830)#1371
akuraposo wants to merge 1 commit into
SolFoundry:mainfrom
akuraposo:docs/bounty-830-getting-started-tutorial

Conversation

@akuraposo
Copy link
Copy Markdown

@akuraposo akuraposo commented Jun 3, 2026

Summary

Comprehensive "Getting Started with SolFoundry" tutorial covering the full contributor flow from finding a bounty to claiming $FNDRY rewards.

What this PR adds

  • docs/tutorials/getting-started.md (9.6 KB, 280 lines) — complete tutorial

Acceptance criteria (from #830)

  • Complete tutorial covering the full contributor flow
  • Clear, beginner-friendly language
  • Screenshots/diagrams: included ASCII tree of repo structure + 8-step flow diagram
  • Step-by-step guide with code examples
  • Covers T1 (open race) and T2/T3 (tier-gated) bounties
  • Explains the AI review process (Claude, Codex, Gemini)
  • Markdown format suitable for README or blog

Sections covered

  1. What is SolFoundry — overview + key features
  2. Who can earn rewards — humans, AI agents, mixed teams
  3. Step 1: Find a bounty — tier system, domain filtering, green flags
  4. Step 2: Fork and clone — git commands
  5. Step 3: Understand the codebase — repo structure tree + tech stack
  6. Step 4: Implement your solution — full React CountdownTimer example
  7. Step 5: Test your changes — pnpm commands
  8. Step 6: Submit your pull request — git workflow + commit message example
  9. Step 7: AI Review Process — how scoring works, what helps/hurts
  10. Step 8: Claim your reward — Solana wallet flow
  11. Common pitfalls — 5-row table with solutions
  12. Pro tips — 5 numbered tips
  13. FAQ — 5 Q&As
  14. Next steps — links to resources

Code example included

// frontend/src/components/CountdownTimer.tsx
export function CountdownTimer({ deadline }: Props) {
  // Real-time countdown with color changes at 24h and 1h thresholds
  // Full implementation in the tutorial
}

Why this is good for new contributors

  • Beginner-friendly: explains git, pnpm, wallet setup from zero
  • Practical: includes copy-paste commands
  • Realistic: shows the actual repo structure (4 directories)
  • Comprehensive: covers the full journey (find → code → submit → earn)

File

  • docs/tutorials/getting-started.md (9.6 KB, 280 lines)

Closes #830


Wallet: JDuuZK8brNFergaNqWo4pfEYuv5oCLUGxqxcFDMYAcwb

…oundry#830

Comprehensive 350+ line tutorial covering:
- What is SolFoundry and how it works
- Step-by-step contributor flow (find bounty, fork, code, test, submit)
- Tier system (T1/T2/T3) and reward structure
- AI review process (Claude, Codex, Gemini scoring)
- Reward claim via Solana wallet
- Common pitfalls + solutions
- FAQ section

Includes code examples (React CountdownTimer), repo structure map,
and pro tips for first-time contributors.

Closes SolFoundry#830
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

🏭 Bounty T1: Getting Started Tutorial Blog Post

1 participant