Skip to content

docs: add local verification steps to CONTRIBUTING - #49

Closed
kshivam4781 wants to merge 1 commit into
forthfate:mainfrom
kshivam4781:docs/local-verification-steps
Closed

kshivam4781 wants to merge 1 commit into
forthfate:mainfrom
kshivam4781:docs/local-verification-steps

Conversation

@kshivam4781

Copy link
Copy Markdown

Closes #17.

What

Adds a "Local verification" section to CONTRIBUTING.md, placed right after the existing "Pre-commit" section, so a first-time contributor can pick the right checks for the kind of change they made instead of guessing or running everything.

Why

CONTRIBUTING.md documented individual commands but never said which ones apply to a docs-only change vs. a frontend change vs. a backend change, and it didn't mention the Playwright specs under frontend/e2e/ at all. The new section covers all four cases called out in the issue:

  • Documentation-only change: no command required, just proofread.
  • Backend change: the existing uv run ruff check ... / PYTHONPATH=backend uv run pytest -q commands (matches .github/workflows/ci.yml's test job).
  • Frontend change: the existing pnpm --filter agent-improvement-console-ui run lint / run build commands (matches the frontend job in .github/workflows/ci.yml).
  • UI end-to-end change: explains that the frontend/e2e/ Playwright specs are not run in CI and need the app running locally plus hand-prepared sample data, so a contributor doesn't assume a green compile means the spec passed.

No application behavior or CI configuration changed, per the issue's acceptance criteria.

Verification

Ran all of the commands the new section documents, from a clean clone, before writing them down:

  • uv run ruff check orbit/ backend/ tests/ — all checks passed
  • PYTHONPATH=backend uv run pytest -q — 44 passed
  • pnpm --filter agent-improvement-console-ui run lint — clean
  • pnpm --filter agent-improvement-console-ui run build — built successfully

I did not run the frontend/e2e/ Playwright specs against a live instance — per the issue and the new section itself, they need a locally running app plus specific sample evaluation builds created by hand, which is exactly the manual step the doc change is describing rather than something this change automates.

Rendered the section with the GitHub Preview tab to confirm the Markdown (bold labels, code fences) renders as intended before opening this PR.

Adds a "Local verification" section to CONTRIBUTING.md so a newcomer can pick the right checks (docs/backend/frontend/e2e) instead of guessing. Backend and frontend commands verified locally (ruff, pytest, eslint, vite build all pass). Closes forthfate#17.
@forthfate

Copy link
Copy Markdown
Owner

@kshivam4781 Thank you again for this thoughtful contribution, especially at such an early stage of OpenOrbit. The local verification breakdown is very helpful.

One small wording suggestion: frontend linting is configured in the local pre-commit hook, but the current CI frontend job only runs the production build. Could we make that distinction clear in the introductory sentence?

Please also update the branch with the latest main when you have a chance. Thanks!

@forthfate
forthfate self-requested a review September 10, 2026 14:40
@forthfate

Copy link
Copy Markdown
Owner

@kshivam4781
Sorry to push, but how are things coming along?

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.

Document local verification steps for frontend, backend, and UI changes

2 participants