|
| 1 | +# Issue Triage and Project Management |
| 2 | + |
| 3 | +This page describes how issues are tracked and triaged across DIRACGrid repositories using GitHub Projects. |
| 4 | + |
| 5 | +## Issue workflow |
| 6 | + |
| 7 | +Issues follow a structured process from idea to completion: |
| 8 | + |
| 9 | +```mermaid |
| 10 | +stateDiagram-v2 |
| 11 | + [*] --> Idea |
| 12 | +
|
| 13 | + Idea --> IssueCreated : Anyone creates GitHub issue |
| 14 | +
|
| 15 | + IssueCreated --> NeedsTriage : Auto-added to Project |
| 16 | +
|
| 17 | + NeedsTriage --> NeedsDesign : Complex/risky, needs architect input |
| 18 | + NeedsTriage --> Triaged : Valid issue, needs refinement |
| 19 | +
|
| 20 | + NeedsDesign --> Triaged : Architect provides design doc/ADR |
| 21 | +
|
| 22 | + Triaged --> Backlog : Clear scope + acceptance criteria + estimate |
| 23 | +
|
| 24 | + Backlog --> InSprint : Selected during sprint planning |
| 25 | +
|
| 26 | + InSprint --> InProgress : Contributor starts work |
| 27 | +
|
| 28 | + InProgress --> InReview : PR opened |
| 29 | +
|
| 30 | + InReview --> InProgress : Changes requested in review |
| 31 | + InReview --> Done : PR approved and merged |
| 32 | +
|
| 33 | + Done --> [*] |
| 34 | +``` |
| 35 | + |
| 36 | +## Workflow states |
| 37 | + |
| 38 | +Issues are tracked through **Project Status** fields, not labels. |
| 39 | + |
| 40 | +### Needs Triage |
| 41 | + |
| 42 | +New issues are automatically added to the Project with Status = "Needs triage". Maintainers review the issue to: |
| 43 | + |
| 44 | +- Confirm it's valid and not a duplicate |
| 45 | +- Set appropriate fields (see [Project fields](#project-fields) below) |
| 46 | +- Determine if it needs design work or can go to the backlog |
| 47 | + |
| 48 | +### Needs Design |
| 49 | + |
| 50 | +Applied to complex or risky issues that require architectural input. An architect or senior developer will: |
| 51 | + |
| 52 | +- Create a design document or Architecture Decision Record (ADR) |
| 53 | +- Outline the technical approach |
| 54 | +- Identify potential risks or trade-offs |
| 55 | + |
| 56 | +Once design is complete, status moves to "Triaged". |
| 57 | + |
| 58 | +### Triaged |
| 59 | + |
| 60 | +The issue is valid and understood but needs refinement. During refinement/grooming: |
| 61 | + |
| 62 | +- Add clear acceptance criteria |
| 63 | +- Add a story point estimate using the **Story Points** field |
| 64 | +- Clarify any open questions |
| 65 | + |
| 66 | +Once refined, status moves to "Backlog". |
| 67 | + |
| 68 | +### Backlog |
| 69 | + |
| 70 | +The issue has clear scope, acceptance criteria, and a story point estimate. It is ready to be picked up in a sprint by anyone, as long as it is something that has been prioritised. |
| 71 | + |
| 72 | +### In Sprint |
| 73 | + |
| 74 | +The issue is assigned to a specific sprint using the **Sprint** field. It was selected during the sprint planning meeting and a developer may be assigned at this stage. Pick up issues based on your availability and avoid taking too many in parallel — it is better to finish one issue before starting another. |
| 75 | + |
| 76 | +### In Progress |
| 77 | + |
| 78 | +A developer has started work. Typically indicated by an open PR or assignment. The issue should be linked to the PR. |
| 79 | + |
| 80 | +### In Review |
| 81 | + |
| 82 | +A pull request has been opened and is awaiting code review. May loop back to "In Progress" if changes are requested. |
| 83 | + |
| 84 | +### Done |
| 85 | + |
| 86 | +The PR has been approved and merged. The issue is automatically closed if properly linked in the PR (e.g. `Closes #123`). |
| 87 | + |
| 88 | +## Project fields |
| 89 | + |
| 90 | +Each issue in the GitHub Project has the following fields: |
| 91 | + |
| 92 | +| Field | Values | |
| 93 | +| ----------------- | -------------------------------------------------------------------------------------------- | |
| 94 | +| **Area** (epic) | See the [GitHub Project](https://github.com/orgs/DIRACGrid/projects/30) for the current list | |
| 95 | +| **Story Points** | Estimated effort | |
| 96 | +| **Sprint** | Sprint assignment | |
| 97 | +| **External Deps** | Whether the issue depends on something external to the project that we cannot influence | |
| 98 | + |
| 99 | +## Creating issues |
| 100 | + |
| 101 | +### Bug reports |
| 102 | + |
| 103 | +When creating a bug report, include: |
| 104 | + |
| 105 | +- A clear description of the bug |
| 106 | +- Confirmation that you've searched for duplicates |
| 107 | +- Steps to reproduce the issue |
| 108 | +- Expected vs. actual behaviour |
| 109 | +- Environment details (OS, version, etc.) |
| 110 | +- Log output if available |
| 111 | + |
| 112 | +### Feature requests |
| 113 | + |
| 114 | +When requesting a feature, provide: |
| 115 | + |
| 116 | +- A user story (As a [user], I want [goal], so that [benefit]) |
| 117 | +- Description of the proposed feature |
| 118 | +- Definition of Done -- what criteria must be met? |
| 119 | +- Related or blocking issues |
0 commit comments