Open Your First Pull Request

Expected time: 15 minutes

Outcome: A reviewer can understand, reproduce, and evaluate your change without reconstructing your work.

1. Review the Final Scope

git status --short
git diff --check
git diff

Remove accidental files from the change and confirm that environment files, secrets, local data, logs, and build output are not included. Do not rewrite unrelated code just before review.

2. Commit Clearly

Use a short conventional-style subject that states the result:

git add path/to/intended-file
git commit -m "fix: clarify analysis empty state"

Stage intended paths explicitly. Avoid git add . until you are experienced enough with the repository to recognize every generated or local-only file.

3. Write a Useful Pull Request

Use this compact structure:

## Summary
- What changed and why

## Validation
- `command that passed`
- Manual scenario and observed result

## Screenshots
- Before and after, when the change is visible

## Notes
- Follow-up work, limitations, or configuration impact

Link the starter issue. Call out new environment variables, migrations, contract changes, or generated-documentation behavior explicitly; a suitable starter issue normally has none of these.

Open the pull request against the team-approved branch. The root workflow normally uses dev for development work and reserves production targeting for approved hotfixes.

4. Work Through Review

Respond to the intent of each comment, ask when a suggestion is unclear, and push focused follow-up commits. Re-run affected validation after review changes. Resolve a conversation only when the concern is addressed or the reviewer agrees with the outcome.

Final Checkpoint

Onboarding is complete when the pull request has a named reviewer, clear validation evidence, and no unexplained changes. After it is reviewed, ask your onboarding partner to choose a second issue that touches one adjacent part of the workflow you traced.

Return to the Tutorials overview or continue with the Web App and Model Server reference documentation.