docs(workflow): formalize gitflow process and templates
This commit is contained in:
35
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
35
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
@ -0,0 +1,35 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Report a defect affecting behavior or reliability
|
||||
title: "[Bug] "
|
||||
labels: bug
|
||||
assignees: ""
|
||||
---
|
||||
|
||||
## Description
|
||||
|
||||
What is wrong?
|
||||
|
||||
## Steps to Reproduce
|
||||
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
|
||||
## Expected Behavior
|
||||
|
||||
What should happen?
|
||||
|
||||
## Actual Behavior
|
||||
|
||||
What happens instead?
|
||||
|
||||
## Environment
|
||||
|
||||
- Branch:
|
||||
- Commit:
|
||||
- Docker command used:
|
||||
|
||||
## Logs / Screenshots
|
||||
|
||||
Add relevant logs or screenshots.
|
||||
5
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
5
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@ -0,0 +1,5 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: Contribution Guidelines
|
||||
url: ./CONTRIBUTING.md
|
||||
about: Read branch rules and PR checklist before opening work items.
|
||||
30
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
30
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
@ -0,0 +1,30 @@
|
||||
---
|
||||
name: Feature request
|
||||
about: Propose a new capability aligned with product milestones
|
||||
title: "[Feature] "
|
||||
labels: enhancement
|
||||
assignees: ""
|
||||
---
|
||||
|
||||
## Problem
|
||||
|
||||
What user or business problem are we solving?
|
||||
|
||||
## Proposed Solution
|
||||
|
||||
Describe the minimum viable implementation.
|
||||
|
||||
## Scope
|
||||
|
||||
- In scope:
|
||||
- Out of scope:
|
||||
|
||||
## Acceptance Criteria
|
||||
|
||||
- [ ]
|
||||
- [ ]
|
||||
|
||||
## GitFlow Plan
|
||||
|
||||
- Branch suggestion: `feature/<scope>-<short-description>`
|
||||
- Target milestone:
|
||||
26
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
26
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
@ -0,0 +1,26 @@
|
||||
## Summary
|
||||
|
||||
Describe what changed and why.
|
||||
|
||||
## Branch and Target
|
||||
|
||||
- Source branch: `feature/*` / `release/*` / `hotfix/*`
|
||||
- Target branch: `develop` / `main`
|
||||
|
||||
## Checklist
|
||||
|
||||
- [ ] Scope is focused and avoids unrelated refactors
|
||||
- [ ] Docker stack runs (`docker compose up -d`)
|
||||
- [ ] Tests are passing
|
||||
- [ ] Migrations included (if needed)
|
||||
- [ ] Docs updated (if needed)
|
||||
- [ ] Changelog updated under `Unreleased`
|
||||
- [ ] No secrets committed
|
||||
|
||||
## Testing
|
||||
|
||||
List commands and key outputs.
|
||||
|
||||
## Risk and Rollback
|
||||
|
||||
Briefly note deployment risk and rollback approach.
|
||||
Reference in New Issue
Block a user