Surface pre-push format/lint checks for all packages, not just sdk/#39241
Open
jeremymeng wants to merge 2 commits into
Open
Surface pre-push format/lint checks for all packages, not just sdk/#39241jeremymeng wants to merge 2 commits into
jeremymeng wants to merge 2 commits into
Conversation
A change under common/tools/dev-tool failed the check-format CI job because the pre-push checks guidance was buried (5th bullet in sdk-workflow's Important Notes) and read as SDK-only. Elevate it to a prominent "Before you push" section, state that it applies to common/tools/* and eng/* too, and add a one-line pointer from AGENTS.md so it's visible without loading the skill. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Improves visibility of pre-push validation guidance across the repository.
Changes:
- Elevates pre-push checks in the workflow skill.
- Adds a prominent routing note to
AGENTS.md.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
AGENTS.md |
Adds repository-wide pre-push guidance. |
.github/skills/sdk-workflow/SKILL.md |
Documents required local checks and commands. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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.
What
Docs-only change to improve agent discoverability of pre-push format/lint/build/test checks.
Why
A PR that changed
common/tools/dev-toolfailed thecheck-formatCI job because the code wasn't Prettier-formatted before pushing. The repo already documented the pre-push checks, but the guidance was buried (5th bullet under "Important Notes" in thesdk-workflowskill) and framed as SDK-only, so an agent editing an internal tools package undercommon/tools/*could easily miss it.Fix
.github/skills/sdk-workflow/SKILL.md— Elevate the rule into a prominent new## Before you push (required for every change)section near the top, and make its scope explicit: it applies tocommon/tools/*(e.g.dev-tool,warp) andeng/*, not justsdk/. The now-redundantPre-push checksbullet under "Important Notes" is removed (relocated, not duplicated).AGENTS.md— Add a one-line routing pointer right after the guidance table so the rule is visible without loading the skill.Docs-only; no code changed.