-
Notifications
You must be signed in to change notification settings - Fork 1k
docs: add contributor onboarding guide #862
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.
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
sehawq
wants to merge
4
commits into
google:main
Choose a base branch
from
sehawq:codex/docs-onboarding
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+82
−0
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| # Contributor Onboarding | ||
|
|
||
| This guide helps first-time contributors, students, and hackathon teams get from zero to their first PR. | ||
|
|
||
| ## 1. Pick a path (15-30 minutes) | ||
|
|
||
| - **Run the demo**: Follow the [Quickstart](../quickstart.md) to see A2UI end-to-end. | ||
| - **Build a renderer**: Start with [Client Setup](client-setup.md). | ||
| - **Build an agent**: See [Agent Development](agent-development.md). | ||
| - **Docs-only contribution**: Update guides, fix typos, or add examples (lowest risk). | ||
|
|
||
| ## 2. Prerequisites | ||
|
|
||
| - **Node.js** v18+ | ||
| - **Python** 3.10+ (only for agent demos) | ||
| - **uv** (Python package manager) for agent demos | ||
| - **Gemini API key** (only required for agent demos) | ||
|
|
||
| If you only want to contribute docs, you do not need Python or an API key. | ||
|
|
||
| ## 3. Fork and clone (fast path) | ||
|
|
||
| ```bash | ||
| # 1) Fork https://github.com/google/A2UI on GitHub | ||
| # 2) Clone your fork | ||
| git clone https://github.com/<your-username>/A2UI.git | ||
| cd A2UI | ||
|
|
||
| # 3) (Optional) Add upstream for syncing | ||
| git remote add upstream https://github.com/google/A2UI.git | ||
| ``` | ||
|
|
||
| Then follow the [Quickstart](../quickstart.md) for the one-command demo. | ||
|
|
||
| ## 4. Find a starter task | ||
|
|
||
| Good places to start: | ||
|
|
||
| - [good first issue](https://github.com/google/A2UI/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) | ||
| - [documentation](https://github.com/google/A2UI/issues?q=is%3Aissue+is%3Aopen+label%3Adocumentation) | ||
| - [help wanted](https://github.com/google/A2UI/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) | ||
|
|
||
| If you are new, docs issues are the quickest way to get a PR merged. | ||
|
|
||
| ## 5. Make a change | ||
|
|
||
| ```bash | ||
| git checkout -b your-branch-name | ||
| # edit files | ||
| ``` | ||
|
|
||
| - Keep changes small and focused. | ||
| - If you touched code, run the relevant tests. | ||
| - For docs-only changes, a quick review is usually enough. | ||
|
|
||
| ## 6. Open a PR | ||
|
|
||
| Before opening a PR, sign the [Google CLA](https://cla.developers.google.com/about). | ||
|
|
||
| Then open a PR against `main` and include: | ||
|
|
||
| - A short summary of what changed | ||
| - A link to the issue (if there is one) | ||
| - Any test results (or note "docs-only") | ||
|
|
||
| See [CONTRIBUTING.md](../../CONTRIBUTING.md) for full details. | ||
|
|
||
| ## 7. After you open the PR | ||
|
|
||
| - Respond to review comments | ||
| - Keep the PR focused; follow-up changes can be new PRs | ||
| - If CI fails, push a fix and re-run checks | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.