docs: add local verification steps to CONTRIBUTING - #102
Open
kshivam4781 wants to merge 1 commit into
Open
kshivam4781 wants to merge 1 commit into
kshivam4781 wants to merge 1 commit into
Conversation
Added local verification instructions for different types of changes, including backend, frontend, and UI end-to-end changes.
Owner
|
@kshivam4781 Thank you so much for putting this together! These local verification steps will be really helpful for contributors. One small thing: CI also runs pnpm run docs:build with strict validation for every PR. Would you mind adding that for documentation changes and updating the note that says no command is required? |
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
2 participants
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. Supersedes #49 (that branch was 278 commits behind main and couldn't be cleanly updated, so this reopens the same change on a fresh branch off current main).
Adds a "Local verification" section to CONTRIBUTING.md, right after "Pre-commit", so a contributor can pick the right checks for the kind of change they made.
Addresses the review feedback on #49: the introductory sentence now distinguishes CI's frontend job (production build only) from the pre-commit hook (which runs ESLint), instead of implying CI runs both the same way.
Verified against the current main branch: the backend commands (
uv run ruff check orbit/ backend/ tests/,PYTHONPATH=backend uv run pytest -q) and frontend commands (pnpm --filter agent-improvement-console-ui run lint/run build) match.github/workflows/ci.ymlexactly as of this PR.