docs: add branch-naming / push-safety / body-formatting rules - #271
Merged
Conversation
The GitHub repo moved from ROCm/flashinfer to AMD-Ecosystem/flashinfer. Update the PR-target safeguards in CLAUDE.md and the pr-workflow skill (repo slug, gh set-default check, gh api paths, GraphQL owner) to match. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Add a PR/issue body formatting rule to CLAUDE.md: GitHub renders a single newline inside a paragraph as <br>, so column-wrapped prose breaks mid-sentence. Write each paragraph/bullet on one line and soft-wrap. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Port the "Branch naming" and "CRITICAL: ask before pushing to remote" sections from AMD-Ecosystem/flashinfer-bench's pr-workflow skill, placed in the same relative position (after the PR-target section). Repo name adapted to AMD-Ecosystem/flashinfer. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR updates repository workflow documentation to reflect the move to AMD-Ecosystem/flashinfer, and codifies additional contribution safety/convention rules (branch naming, push confirmation, and GitHub body formatting).
Changes:
- Retargets PR-target safeguards from
ROCm/flashinfertoAMD-Ecosystem/flashinfer(includinggh/API examples). - Adds explicit branch naming guidance and a fail-closed “ask before pushing” rule.
- Adds a rule to avoid hard-wrapping PR/issue bodies because GitHub treats single newlines as
<br>.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
CLAUDE.md |
Updates PR target to AMD-Ecosystem/flashinfer and adds branch naming, push-safety, and PR/issue body formatting guidance. |
.claude/skills/pr-workflow/SKILL.md |
Retargets pr-workflow skill documentation and example gh/REST/GraphQL calls to the AMD-Ecosystem/flashinfer repo. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Summary
Repo and PR-workflow documentation updates, split out of #270 so that PR stays focused on the benchmark code change.
What changed
CLAUDE.md— retarget the PR-target safeguard toAMD-Ecosystem/flashinfer(the repo moved fromROCm/flashinfer); add a "PR / issue body formatting" rule (GitHub renders a single newline inside a paragraph as<br>, so rendered bodies must not be hard-wrapped); add "Branch naming" and "CRITICAL: ask before pushing to remote" sections ported from theAMD-Ecosystem/flashinfer-benchpr-workflow skill..claude/skills/pr-workflow/SKILL.md— retarget the repo slug,gh repo set-defaultcheck,gh apipaths, and GraphQLownertoAMD-Ecosystem.Test plan
pre-commit run --files CLAUDE.md .claude/skills/pr-workflow/SKILL.md— markdownlint and the other hooks pass.