Instruction file imported from Pingwire/pingwire-api-documentation (.github/instructions/git-workflow.instructions.md). Copyright stays with the author.

Git workflow

Name: git-workflow
Author: Pingwire

Branch naming

Format: <type>/<ticket-identifier>-<short-description>

<type>: feature, fix, or epic
<ticket-identifier>: e.g. DEV-360 or Data-1234
<short-description>: kebab-case summary, begins with a verb

Example: feature/DEV-360-add-user-authentication

If the ticket identifier or purpose is unclear, ask before creating the branch.

Commit messages

Format: [<ticket-identifier>] <short description>

Example: [DEV-360] Sanitize the document after saving request audit trail events

Keep concise and focused on purpose
Do not add co-authors or additional metadata
When a lot of changes have been made, consider breaking into smaller focused commits

Pull requests

Title format: [<ticket-identifier>] <short description>

Example: [DEV-360] Add user authentication

Create PR to master:

gh pr create --title "<title>" --body "<description>" --base master

The PR description should include a summary of the changes made, the motivation, and any relevant context.

{ "ocm": "1", "id": "pingwire-pingwire-api-documentation-git-workflow-instructions", "kind": "skill", "name": "git-workflow", "description": "Format: `<type>/<ticket-identifier>-<short-description>`", "publisher": "Pingwire", "version": "1.0.0", "capabilities": { "domains": [ "coding", "customer_support" ], "tags": [ "skill-md", "github-instructions" ], "languages": [ "en" ] }, "quality_prior": 0.6, "examples": [ "Format: `<type>/<ticket-identifier>-<short-description>`" ], "primary": false, "metadata": { "source": { "provider": "github-instructions", "repository": "https://github.com/Pingwire/pingwire-api-documentation", "path": ".github/instructions/git-workflow.instructions.md", "ref": "b9587e49ff9849d1a94e769bd7bfc41a16e457cc", "url": "https://github.com/Pingwire/pingwire-api-documentation/blob/b9587e49ff9849d1a94e769bd7bfc41a16e457cc/.github/instructions/git-workflow.instructions.md", "key": "Pingwire/pingwire-api-documentation/.github/instructions/git-workflow.instructions.md" } }, "instructions": "# Git workflow\n\n## Branch naming\n\nFormat: `<type>/<ticket-identifier>-<short-description>`\n\n- `<type>`: `feature`, `fix`, or `epic`\n- `<ticket-identifier>`: e.g. `DEV-360` or `Data-1234`\n- `<short-description>`: kebab-case summary, begins with a verb\n\nExample: `feature/DEV-360-add-user-authentication`\n\nIf the ticket identifier or purpose is unclear, ask before creating the branch.\n\n## Commit messages\n\nFormat: `[<ticket-identifier>] <short description>`\n\nExample: `[DEV-360] Sanitize the document after saving request audit trail events`\n\n- Keep concise and focused on purpose\n- Do not add co-auth", "cost": { "context_tokens": 261 } }

git-workflow

About

Git workflow

Branch naming

Commit messages

Pull requests

Use it

Manifest

Reviews