Submit PR
Create a pull request for the current branch with a well-structured description.
Steps
- Run
make ci— must pass completely before creating PR - Generate the diff against main. Run
git diff main...HEAD > /tmp/pr-diff.txtto capture the full diff between the current branch and the head of main. This is the ONLY source of truth for what the PR contains. Warning: the diff can be very large. If the diff file exceeds context limits, process it in chunks rather than trying to load it all at once. - Derive the PR title and description SOLELY from the diff. Read the diff output and summarize what changed. Ignore commit messages, branch names, and any other metadata — only the actual code/content diff matters.
- Write PR body using the template in
.github/pull_request_template.md - Fill in (based on the diff analysis from step 3):
- TLDR: one sentence
- What Was Added: new files, features, deps
- What Was Changed/Deleted: modified behaviour
- How Tests Prove It Works: specific test names or output
- Spec/Doc Changes: if any
- Breaking Changes: yes/no + description
- Use
gh pr createwith the filled template
Rules
- Never create a PR if
make cifails - PR description must be specific and tight — no vague placeholders
- Link to the relevant GitHub issue if one exists
- DO NOT include yourself as a coauthor!
Success criteria
make cipassed- PR created with
gh pr create - PR URL returned to user
Converted and distributed by TomeVault — claim your Tome and manage your conversions.