Skip to content

docs: add PR process and testing strategy guides#1037

Open
zhoward-1 wants to merge 1 commit intomainfrom
docs/pr-process-and-testing-strategy
Open

docs: add PR process and testing strategy guides#1037
zhoward-1 wants to merge 1 commit intomainfrom
docs/pr-process-and-testing-strategy

Conversation

@zhoward-1
Copy link
Copy Markdown
Contributor

Summary

Adds two contributor guides addressing the most common onboarding friction points:

contributing/pr-process.md

  • Branch naming conventions with prefix table
  • What to include in a PR description
  • Which checks must pass locally before pushing (Go: bazel test, Python: pre-commit + pytest)
  • Review expectations (address all comments, re-request review, resolve conversations)
  • Merge strategy (squash vs merge commit)
  • Guidance on stacked PRs for large changes

contributing/testing.md

  • Three-level test strategy: unit tests, integration tests (sandbox), E2E
  • How to run Go and Python tests locally
  • Per-change-type table: what tests are required for new controllers, plugins, API fields, bug fixes, refactors
  • Test coverage philosophy (behavior over percentage)
  • Guidance on flaky tests

Part of the operator/contributor guide improvements proposed in #1033.

🤖 Generated with Claude Code

pr-process.md covers branch naming, PR descriptions, what checks
must pass, review expectations, and merge criteria.

testing.md covers the three-level test strategy (unit, integration,
sandbox), per-change-type requirements, and local test commands.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
zhoward-1 added a commit that referenced this pull request Apr 10, 2026
- Fix component map: ui/ → javascript/ (ui/ directory does not exist)
- Add stub testing.md and pr-process.md to prevent Docusaurus build
  failures from broken links until the full guides land in #1037

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
zhoward-1 added a commit that referenced this pull request Apr 10, 2026
These will be provided by #1037 instead. Merge #1037 before this PR
to avoid broken links in the Docusaurus build.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
poetry run pytest
```

All CI checks (GitHub Actions) must also be green. See the [CI Guide](ci.md) for how to interpret failures.
Copy link
Copy Markdown
Contributor

@austingreco austingreco Apr 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ci.md doesn't exist yet (created by PR #1045). Wait for that one to be merged first, or build will break

poetry run pytest

# Run a specific test file
poetry run pytest tests/test_uniflow.py
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tests/test_uniflow.py doesn't exist. Actual test files are under tests/uniflow/.

Suggested change
poetry run pytest tests/test_uniflow.py
poetry run pytest tests/uniflow/core/test_build.py

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants