Skip to content

Commit

Permalink
Update feature.md
Browse files Browse the repository at this point in the history
  • Loading branch information
julian-hartl authored Mar 29, 2024
1 parent 6dab9c7 commit b910bc0
Showing 1 changed file with 35 additions and 16 deletions.
51 changes: 35 additions & 16 deletions .github/ISSUE_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,45 @@
---
name: Feature
about: Used for proposing a new feature
title: ''
labels: ''
name: Feature Proposal
about: Template for proposing a new feature or enhancement to the project.
title: 'Feature: <Feature Name>'
labels: 'enhancement'
assignees: ''

---

# Detailed title
# Feature Proposal: <Feature Name>

## Motivation
<!-- Briefly describe the motivation behind this issue. Why is this change or feature necessary? -->
## Background
<!-- Briefly describe the context and motivation behind this feature proposal. Why is the proposed feature necessary, and how does it fit into the current project goals? -->

## Necessary Steps
<!-- List the steps necessary to implement this feature. This can be a checklist. -->
## Objective
<!-- Clearly state the objective of this feature. What is the intended outcome or benefit of implementing this feature? -->

- [ ] Step 1
- [ ] Step 2
- [ ] Step 3
## Proposed Solution
<!-- Provide a detailed description of the proposed solution. Include any technical specifics, architectural changes, and how it would integrate with the existing project components. If applicable, add diagrams or mockups to support your explanation. -->

## Possible Challenges
<!-- Discuss any potential challenges or complexities that might arise in the implementation of this feature. -->
## Detailed Implementation Steps
<!-- Break down the implementation into concrete steps. This helps in understanding the effort required and could serve as a checklist during development. -->

- [ ] Step 1: Description of the first step.
- [ ] Step 2: Description of the second step.
- [ ] Step 3: Description of the third step.
- [ ] Add more steps as necessary.

## Potential Challenges and Considerations
<!-- Identify any potential challenges or obstacles that might arise during the implementation of this feature. Discuss possible solutions or approaches to these challenges. -->

- Challenge 1: Description and potential ways to address it.
- Challenge 2: Description and potential ways to address it.
- Add more challenges as identified.

## Testing Strategy
<!-- Describe the approach for testing this feature. Specify any new testing frameworks that might be needed, how regressions will be prevented, and any specific areas that need thorough testing. -->

- Testing Step 1: Description of the first testing step or strategy.
- Testing Step 2: Description of the second testing step or strategy.
- Add more testing steps or strategies as necessary.

## Additional Comments
<!-- Provide any additional comments or relevant information not covered above. This could include implications on other project components, required updates to documentation, or dependencies on other tasks or features. -->

- Challenge 1
- Challenge 2

0 comments on commit b910bc0

Please sign in to comment.