Skip to content

docs: add branch-naming / push-safety / body-formatting rules - #271

Merged
demandal25 merged 4 commits into
amd-integrationfrom
pr-workflow-doc-updates
Jul 29, 2026
Merged

docs: add branch-naming / push-safety / body-formatting rules#271
demandal25 merged 4 commits into
amd-integrationfrom
pr-workflow-doc-updates

Conversation

@demandal25

@demandal25 demandal25 commented Jul 29, 2026

Copy link
Copy Markdown
Collaborator

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 to AMD-Ecosystem/flashinfer (the repo moved from ROCm/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 the AMD-Ecosystem/flashinfer-bench pr-workflow skill.
  • .claude/skills/pr-workflow/SKILL.md — retarget the repo slug, gh repo set-default check, gh api paths, and GraphQL owner to AMD-Ecosystem.

Test plan

  • pre-commit run --files CLAUDE.md .claude/skills/pr-workflow/SKILL.md — markdownlint and the other hooks pass.
  • Docs-only change; no code paths touched, so no pytest applies.

demandal25 and others added 3 commits July 29, 2026 12:22
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>
Copilot AI review requested due to automatic review settings July 29, 2026 16:24

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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/flashinfer to AMD-Ecosystem/flashinfer (including gh/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.

@demandal25 demandal25 changed the title docs: retarget PR workflow to AMD-Ecosystem and add branch-naming / push-safety / body-formatting rules docs: add branch-naming / push-safety / body-formatting rules Jul 29, 2026
Copilot AI review requested due to automatic review settings July 29, 2026 16:39

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

@demandal25
demandal25 merged commit d2e9a19 into amd-integration Jul 29, 2026
2 checks passed
@demandal25
demandal25 deleted the pr-workflow-doc-updates branch July 29, 2026 16:51
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.

2 participants