feat: add project estimation issue template (#40057)
Add a comprehensive GitHub issue template for project estimation that
includes:
- Project overview and dependencies
- Technical considerations and requirements
- Resource allocation and risk management
- CI/CD, testing, and deployment planning
- Documentation and post-release activities
This template will help teams create more thorough and standardized
project estimates.
## Description
> [!TIP]
> _Add a TL;DR when the description is longer than 500 words or
extremely technical (helps the content, marketing, and DevRel team)._
>
> _Please also include relevant motivation and context. List any
dependencies that are required for this change. Add links to Notion,
Figma or any other documents that might be relevant to the PR._
Fixes #`Issue Number`
_or_
Fixes `Issue URL`
> [!WARNING]
> _If no issue exists, please create an issue first, and check with the
maintainers if the issue is valid._
## Automation
/ok-to-test tags=""
### 🔍 Cypress test results
<!-- This is an auto-generated comment: Cypress test results -->
> [!CAUTION]
> If you modify the content in this section, you are likely to disrupt
the CI result for your PR.
<!-- end of auto-generated comment: Cypress test results -->
## Communication
Should the DevRel and Marketing teams inform users about this change?
- [ ] Yes
- [ ] No
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
- **New Features**
- Introduced a comprehensive project estimation template with structured
sections for users to provide detailed information on project overview,
dependencies, scope, technical considerations, CI/CD processes, testing,
release strategy, documentation, resource allocation, risk management,
and post-release activities.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
This commit is contained in:
vivek-appsmith
GitHub
parent
076bd32ed9
commit
41416e2362
191
.github/ISSUE_TEMPLATE/--project-estimation.yaml
vendored
Normal file
191
.github/ISSUE_TEMPLATE/--project-estimation.yaml
vendored
Normal file
|
|
@ -0,0 +1,191 @@
|
||||||
|
name: 📊 Project Estimation
|
||||||
|
description: A comprehensive checklist for estimating project scope and requirements
|
||||||
|
title: "[Estimation]: "
|
||||||
|
labels: [Project Planning, Needs Review]
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Thanks for taking the time to create this project estimation! Please fill out all relevant sections to ensure comprehensive planning.
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Project Overview
|
||||||
|
description: Brief description of the project and its goals
|
||||||
|
placeholder: |
|
||||||
|
Provide a high-level overview of the project, its objectives, and expected outcomes.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Dependencies
|
||||||
|
description: List all internal and external dependencies
|
||||||
|
placeholder: |
|
||||||
|
## Internal Dependencies
|
||||||
|
- Teams/systems your work depends on
|
||||||
|
- Cross-functional needs
|
||||||
|
|
||||||
|
## External Dependencies
|
||||||
|
- Third-party services
|
||||||
|
- License approvals needed
|
||||||
|
|
||||||
|
## Documentation Dependencies
|
||||||
|
- Required documentation with owners and timelines
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Scope & Requirements
|
||||||
|
description: Document clear requirements and acceptance criteria
|
||||||
|
placeholder: |
|
||||||
|
## Requirements
|
||||||
|
- List key requirements
|
||||||
|
- Acceptance criteria
|
||||||
|
|
||||||
|
## Known Assumptions
|
||||||
|
- List assumptions
|
||||||
|
- Impact of assumptions
|
||||||
|
|
||||||
|
## Stakeholder Alignment
|
||||||
|
- Key stakeholders
|
||||||
|
- Priority alignment
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Technical Considerations
|
||||||
|
description: Document technical architecture and considerations
|
||||||
|
placeholder: |
|
||||||
|
## Architecture
|
||||||
|
- Design approach
|
||||||
|
- Tech stack details
|
||||||
|
|
||||||
|
## Technical Requirements
|
||||||
|
- Scalability needs
|
||||||
|
- Security considerations
|
||||||
|
- Performance requirements
|
||||||
|
|
||||||
|
## Testing Strategy
|
||||||
|
- Unit testing approach
|
||||||
|
- Integration testing
|
||||||
|
- E2E testing
|
||||||
|
- Test automation coverage
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: CI/CD Pipeline
|
||||||
|
description: Document CI/CD requirements and considerations
|
||||||
|
placeholder: |
|
||||||
|
## Pipeline Requirements
|
||||||
|
- Build process
|
||||||
|
- Deployment strategy
|
||||||
|
- Rollback procedures
|
||||||
|
|
||||||
|
## Monitoring
|
||||||
|
- Required metrics
|
||||||
|
- Alerting setup
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Reviews & Approvals
|
||||||
|
description: Document required reviews and approvals
|
||||||
|
placeholder: |
|
||||||
|
## Required Reviews
|
||||||
|
- Code review process
|
||||||
|
- Design review requirements
|
||||||
|
- Security review needs
|
||||||
|
- Compliance requirements
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Testing Requirements
|
||||||
|
description: Document testing requirements and approach
|
||||||
|
placeholder: |
|
||||||
|
## Testing Scope
|
||||||
|
- Test data requirements
|
||||||
|
- Environment needs
|
||||||
|
- Test case management
|
||||||
|
- Performance testing requirements
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Release & Deployment
|
||||||
|
description: Document release and deployment strategy
|
||||||
|
placeholder: |
|
||||||
|
## Release Strategy
|
||||||
|
- Phased rollout plan
|
||||||
|
- Deployment steps
|
||||||
|
- Monitoring plan
|
||||||
|
- Rollback procedures
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Documentation Requirements
|
||||||
|
description: Document required documentation
|
||||||
|
placeholder: |
|
||||||
|
## Required Documentation
|
||||||
|
- Technical documentation
|
||||||
|
- User documentation
|
||||||
|
- Knowledge transfer needs
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Resource Allocation
|
||||||
|
description: Document resource requirements
|
||||||
|
placeholder: |
|
||||||
|
## Team Resources
|
||||||
|
- Required team members
|
||||||
|
- Skill requirements
|
||||||
|
- Training needs
|
||||||
|
|
||||||
|
## External Resources
|
||||||
|
- Contractor needs
|
||||||
|
- Tooling requirements
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Risk Management
|
||||||
|
description: Document risks and mitigation strategies
|
||||||
|
placeholder: |
|
||||||
|
## Identified Risks
|
||||||
|
- Technical risks
|
||||||
|
- Timeline risks
|
||||||
|
- External dependencies
|
||||||
|
|
||||||
|
## Mitigation Strategies
|
||||||
|
- Risk mitigation plans
|
||||||
|
- Contingency buffers
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Project Management
|
||||||
|
description: Document project management approach
|
||||||
|
placeholder: |
|
||||||
|
## Work Breakdown
|
||||||
|
- Task breakdown
|
||||||
|
- Effort estimation
|
||||||
|
- Timeline estimates
|
||||||
|
|
||||||
|
## Tracking
|
||||||
|
- Progress tracking method
|
||||||
|
- Buffer allocation
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Post-Release
|
||||||
|
description: Document post-release requirements
|
||||||
|
placeholder: |
|
||||||
|
## Post-Release Activities
|
||||||
|
- Monitoring requirements
|
||||||
|
- Feedback collection
|
||||||
|
- Retrospective planning
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
Loading…
Reference in New Issue
Block a user