Proto-UI/Proto-UI

Write the first-adapter contributor guide

Closed

#236 opened on May 4, 2026

View on GitHubContributor guide
 (4 comments) (0 reactions) (1 assignee)TypeScript (12 forks)auto 404
F5 - Largeadapterdocsgood first issuehelp wantedv0 launch

Repository metrics

Stars
 (29 stars)
PR merge metrics
 (PR metrics pending)

Description

Campaign: v0-good-first-issues Seed id: first-adapter-guide

Summary

Write a practical guide that helps a new contributor evaluate and start their first Proto UI adapter.

Scope

  • Explain the adapter proposal path.
  • Link to the host capability checklist.
  • Walk through a minimal adapter validation plan.

Acceptance criteria

  • The guide distinguishes a research spike from a production adapter.
  • The guide includes expected tests or demos for a minimal adapter.
  • The guide links to existing React, Vue, and Web Component adapters.

References

  • apps/www/src/content/docs/en/build/adapter-guide.md
  • packages/adapters/react
  • packages/adapters/vue
  • packages/adapters/web-component

Out of scope

  • Adding a new adapter.
  • Changing adapter contracts.

Maintainer notes

Category: docs Difficulty: small

Contributor guide

Research direction
Read the existing adapter guide template and study the React, Vue, and Web Component adapters to understand the pattern, then draft a guide based on the acceptance criteria.
Tech stack
typescript
Domain
full stack
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80