docs: add local verification steps to CONTRIBUTING - #49
Closed
kshivam4781 wants to merge 1 commit into
Closed
kshivam4781 wants to merge 1 commit into
kshivam4781 wants to merge 1 commit into
Conversation
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.
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 |
forthfate
self-requested a review
September 10, 2026 14:40
Owner
|
@kshivam4781 |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
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:uv run ruff check .../PYTHONPATH=backend uv run pytest -qcommands (matches.github/workflows/ci.yml'stestjob).pnpm --filter agent-improvement-console-ui run lint/run buildcommands (matches thefrontendjob in.github/workflows/ci.yml).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 passedPYTHONPATH=backend uv run pytest -q— 44 passedpnpm --filter agent-improvement-console-ui run lint— cleanpnpm --filter agent-improvement-console-ui run build— built successfullyI 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.