Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
225 changes: 225 additions & 0 deletions .github/projects/PLANNING_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,225 @@
---
title: "Project Planning Template"
description: "Use this template to document planning before creating related issues"
file_type: "planning"
created_date: "YYYY-MM-DD"
status: "active"
---

# Project Planning: [Project Name]

**Created:** YYYY-MM-DD
**Status:** Planning / In Progress / Completed
**Owner:** @username
**Repository:** lightspeedwp/.github

---

## 1. Overview & Goals

**What is this project trying to accomplish?**

Brief 2-3 sentence summary of the project's purpose, scope, and business/technical value.

### Primary Goals

- Goal 1: [specific, measurable outcome]
- Goal 2: [specific, measurable outcome]
- Goal 3: [specific, measurable outcome]

### Success Criteria

- [ ] Criterion 1
- [ ] Criterion 2
- [ ] Criterion 3

---

## 2. Scope & Deliverables

**What's in scope? What's out of scope?**

### Included

- Deliverable 1: [description]
- Deliverable 2: [description]
- Deliverable 3: [description]

### Excluded

- [What is NOT included and why]
- [What is deferred to future phase]

### Dependencies

- Dependency on [related project/issue] (#123)
- Dependency on [external system/tool]
- Dependency on [team/capability]

---

## 3. Timeline & Milestones

**When should this be completed?**

| Milestone | Target Date | Status |
| --- | --- | --- |
| Phase 1: Planning & Design | YYYY-MM-DD | Not Started |
| Phase 2: Implementation | YYYY-MM-DD | Not Started |
| Phase 3: Review & Testing | YYYY-MM-DD | Not Started |
| Phase 4: Completion | YYYY-MM-DD | Not Started |

### Estimated Effort

- Total: [X hours / days / weeks]
- Per phase: Phase 1: 4h, Phase 2: 12h, Phase 3: 6h, Phase 4: 2h
- Team: [1 person / 2 people / team composition]

---

## 4. Technical Architecture (if applicable)

**How will this be implemented?**

### High-Level Design

[ASCII diagram, Mermaid flowchart, or detailed description of the technical approach]

### Key Components

1. Component A: [responsibility]
2. Component B: [responsibility]
3. Component C: [responsibility]

### Technology Stack

- Language/Framework: [specific version]
- Key libraries: [list with versions]
- Infrastructure: [if applicable]

### Design Decisions & Rationale

| Decision | Rationale | Alternatives Considered |
| --- | --- | --- |
| [Design choice 1] | [Why this approach] | [Other options and why not chosen] |
| [Design choice 2] | [Why this approach] | [Other options and why not chosen] |

---

## 5. Risks & Mitigation

**What could go wrong? How will we reduce risk?**

| Risk | Likelihood | Impact | Mitigation Strategy |
| --- | --- | --- | --- |
| [Risk 1] | High/Medium/Low | [Impact] | [Mitigation plan] |
| [Risk 2] | High/Medium/Low | [Impact] | [Mitigation plan] |
| [Risk 3] | High/Medium/Low | [Impact] | [Mitigation plan] |

---

## 6. Testing Strategy

**How will this be validated?**

### Unit Tests

- [What components need unit tests]
- [Coverage targets]

### Integration Tests

- [What integrations need testing]
- [Test scenarios]

### Manual Testing Checklist

- [ ] Golden path scenario: [steps]
- [ ] Edge case 1: [steps]
- [ ] Edge case 2: [steps]
- [ ] Regression test for related feature: [steps]

### Acceptance Criteria

[Link to GitHub issues with acceptance criteria, or list them here]

---

## 7. Documentation & Communication

**What needs to be documented?**

- [ ] README or setup guide
- [ ] Architecture decision record (ADR)
- [ ] User/developer guide
- [ ] CONTRIBUTING updates
- [ ] Changelog entry
- [ ] GitHub project documentation
- [ ] Team wiki or knowledge base

### Stakeholders & Communication Plan

- **Decision Makers:** [Who must approve]
- **Implementers:** [Who will build]
- **Reviewers:** [Who will review]
- **Communication:** [When/how to update stakeholders]

---

## 8. Related Issues & References

**GitHub issues, PRs, discussions, or external links**

- Related issue: [#123 - Issue title](https://github.com/lightspeedwp/.github/issues/123)
- Blocking issue: [#124 - Issue title](https://github.com/lightspeedwp/.github/issues/124)
- Blocked by: [#125 - Issue title](https://github.com/lightspeedwp/.github/issues/125)
- Reference: [Link to spec, design doc, or external resource]

---

## 9. Sign-Off & Approval

**Who has approved this plan?**

| Role | Name | Date | Notes |
| --- | --- | --- | --- |
| Owner | @username | YYYY-MM-DD | [Any notes] |
| Reviewer | @username | YYYY-MM-DD | [Any notes] |
| Approver | @username | YYYY-MM-DD | [Any notes] |

---

## Planning Checklist

Before creating related GitHub issues, confirm:

- [ ] Goals are clear and measurable
- [ ] Scope is well-defined (in/out)
- [ ] Timeline is realistic
- [ ] Technical design is documented
- [ ] Risks have been identified & mitigated
- [ ] Testing strategy is defined
- [ ] Documentation needs are listed
- [ ] Dependencies are tracked
- [ ] Stakeholders have been informed
- [ ] Approval chain is complete

Once this planning document is approved, you're ready to:
1. Create GitHub issues for each task/deliverable
2. Link issues back to this planning document in their description
3. Add issues to the appropriate GitHub project
4. Begin implementation

---

## Change Log

| Date | Change | Author |
| --- | --- | --- |
| YYYY-MM-DD | Initial planning | @username |

---

**Template Version:** 1.0
**Last Updated:** 2026-05-31
**See also:** [CONTRIBUTING.md](../../../CONTRIBUTING.md), [Issue Triage Guide](../../../docs/issue-triage-guide.md)
Loading
Loading