| name | github-workflow |
| version | 1.0.0 |
| description | Git and GitHub conventions for commits, branches, and PRs in Pantas Green projects. Use when: committing code, creating branches, making PRs, fixing CI failures, git operations. Triggers: commit, push, PR, pull request, branch, git, gh, GRE-, autopep8, CI, merge, rebase |
GitHub Workflow
Quick Reference
| Action | Format |
|---|---|
| Branch | GRE-<ticket>-<description> |
| Commit | <type>: <description> |
| PR Title | GRE-<ticket>: <description> (<component>) |
Branch Naming
Format: GRE-<ticket-number>-<short-description>
Examples:
GRE-4160-display-last-sign-on-infoGRE-4111-fix-pim-backfill
Rules:
- Always prefix with Jira ticket number
- Use lowercase letters
- Use hyphens to separate words
- Keep description short (3-5 words)
Commit Message Format
<type>: <short description>
- <bullet point details>
- <bullet point details>
Types:
feat: New featurefix: Bug fixrefactor: Code refactoringdocs: Documentation changestest: Adding/updating testschore: Maintenance tasksstyle: Formatting changes
Before Committing (MANDATORY)
ALWAYS run code formatters:
# Python (Backend)
autopep8 --in-place --aggressive --aggressive <files>
# TypeScript/JavaScript (Frontend)
npx prettier --write <files>
Commit Workflow
- Check git status
- Ask which files (if not specified)
- Ask for ticket number (if not known)
- Run code formatters
- Stage files:
git add <files> - Create commit with proper format
- Verify with
git status
PR Workflow
- Check branch status (not on master)
- Push if needed with
-uflag - Gather context (ticket, diff, related PRs)
- Create PR with
gh pr create - Return PR URL
Important Notes
- ALWAYS run formatters before committing
- Always ask for Jira ticket if not provided
- Never commit
.env, credentials, or secrets - Never commit
node_modules/or generated files - Always include UAT test plan in PRs
- Link related PRs for multi-repo changes