GitHub Pull Request Workflow
Create a Pull Request for the current branch.
Title
- Concise English title, one line
- Apply the same prefix convention as commit messages (e.g., feat:, fix:, docs:)
Description
- Include a summary of changes, motivation or context, and how it was tested
- Reference related issues with
Fixes #NorCloses #Nwhen applicable - If the repository has a PR template (
.github/PULL_REQUEST_TEMPLATE.mdor.github/PULL_REQUEST_TEMPLATE/), follow its structure - If
CONTRIBUTING.mdorDEVELOPMENT.mdexists, review them and ensure the PR follows the project's conventions
Workflow
- Check whether the branch has been pushed to the remote
- If not, prompt the user to push — never push on your own
- Check for a PR template and use it if present
- Review
CONTRIBUTING.mdandDEVELOPMENT.mdif they exist - Draft the title and description, then show the proposal to the user for confirmation
- After approval, run
gh pr create --title $TITLE --body $BODY
Converted and distributed by TomeVault — claim your Tome and manage your conversions.