Add Gitea issue workflow documentation
This commit is contained in:
60
GITEA_ISSUES.md
Normal file
60
GITEA_ISSUES.md
Normal file
@@ -0,0 +1,60 @@
|
||||
# Gitea Issue Workflow
|
||||
|
||||
## Process for Working with Gitea Issues
|
||||
|
||||
### 1. Read Issue
|
||||
```bash
|
||||
# Get all issues
|
||||
curl -s "https://gitea.calmcacil.dev/api/v1/repos/{owner}/{repo}/issues?state=open" | jq '.'
|
||||
|
||||
# Get specific issue
|
||||
curl -s "https://gitea.calmcacil.dev/api/v1/repos/{owner}/{repo}/issues/{number}" | jq '.'
|
||||
```
|
||||
|
||||
### 2. Analyze Issue
|
||||
- Read title and body
|
||||
- Check labels, assignee, milestone
|
||||
- Identify blocking dependencies
|
||||
- Determine if actionable
|
||||
|
||||
### 3. Create Task List
|
||||
- Use `todowrite` for multi-step issues
|
||||
- Break down into actionable steps
|
||||
- Mark first step `in_progress`
|
||||
|
||||
### 4. Implement Fix
|
||||
- Follow existing code patterns
|
||||
- Make minimal changes
|
||||
- Update relevant documentation
|
||||
|
||||
### 5. Verify Fix
|
||||
- Run any available tests
|
||||
- Manual verification of functionality
|
||||
- Check for side effects
|
||||
|
||||
### 6. Commit Changes
|
||||
```bash
|
||||
git add -A
|
||||
git commit -m "Brief description
|
||||
|
||||
Details about what was fixed.
|
||||
|
||||
Closes #{issue_number}"
|
||||
```
|
||||
|
||||
### 7. Push and Close
|
||||
```bash
|
||||
bd sync
|
||||
git push
|
||||
```
|
||||
|
||||
The `Closes #{issue_number}` in commit message will automatically close the issue via Gitea API.
|
||||
|
||||
## Guidelines
|
||||
|
||||
- Always read the full issue before starting work
|
||||
- If issue is unclear, ask for clarification
|
||||
- Create todos for 2+ step tasks
|
||||
- Reference issue in commit message with `Closes #`
|
||||
- Verify the fix actually resolves the issue
|
||||
- Update documentation if behavior changes
|
||||
Reference in New Issue
Block a user