Skip to content

Commit 3134b05

Browse files
committed
imporove feature template
1 parent 5312d41 commit 3134b05

1 file changed

Lines changed: 27 additions & 71 deletions

File tree

.github/ISSUE_TEMPLATE/request-a-feature.md

Lines changed: 27 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -7,85 +7,41 @@ assignees: ''
77

88
---
99

10-
<!--
11-
Thank you for contributing to java-tron!
12-
Please provide as much detail as possible to help us evaluate your feature request.
13-
-->
14-
15-
## Problem Statement
16-
17-
<!-- Describe the problem this feature solves, the context/motivation, and who would benefit -->
10+
# Summary
11+
<!-- Provide a concise description of the problem and the proposed solution.-->
1812

19-
## Proposed Solution
13+
# Problem
14+
### Motivation
15+
<!-- Describe the context or motivation if necessary. -->
2016

21-
<!-- Describe your proposed solution in detail -->
17+
### Current State
18+
<!-- Describe the current behavior of the system. -->
2219

23-
### Specification
20+
### Limitations or Risks
21+
<!-- Explain the limitations, risks, or inefficiencies. -->
2422

25-
<!-- Provide technical specifications or requirements -->
23+
# Proposed Solution
2624

27-
**API Changes** (if applicable)
28-
<!-- Describe any new or modified APIs -->
25+
### Proposed Design
26+
<!-- Describe the proposed solution at a high level. Implementation details are optional but encouraged if relevant.-->
2927

30-
**Configuration Changes** (if applicable)
31-
<!-- Describe any new configuration options -->
28+
### Key Changes
29+
<!-- List the main areas affected by this proposal, such as Module(s), Configuration and API. -->
3230

33-
**Protocol Changes** (if applicable)
34-
<!-- Describe any changes to the TRON protocol -->
31+
# Impact
32+
<!-- Assess the expected impact of this change, such as Security, Stability, Performance, Developer Experience -->
3533

36-
## Scope of Impact
37-
38-
<!-- Select the system components that will be affected by this feature:
39-
- Core protocol
40-
- API/RPC
41-
- Database
42-
- Network layer
43-
- Smart contracts
44-
- Documentation
45-
- Others, please specify
34+
# Compatibility
35+
<!--
36+
* Breaking Change: Yes / No
37+
* Default Behavior Change:
38+
* Migration Required:
39+
Provide details if any of the above is applicable.
4640
-->
4741

48-
**Breaking Changes**
49-
<!-- Will this feature introduce any breaking changes? -->
50-
51-
**Backward Compatibility**
52-
<!-- How will this feature maintain backward compatibility? -->
53-
54-
## Implementation
55-
56-
**Do you have ideas regarding the implementation?**
57-
<!-- Share any technical approaches or implementation details -->
58-
59-
**Are you willing to implement this feature?**
60-
<!-- Let us know if you'd like to contribute the implementation -->
61-
62-
**Estimated Complexity**
63-
<!-- Your assessment of implementation complexity, choose among
64-
- Low (minor changes)
65-
- Medium (moderate changes)
66-
- High (significant changes)
67-
- Unknown
68-
-->
69-
70-
## Testing Strategy
71-
72-
<!-- How should this feature be tested? -->
73-
74-
**Test Scenarios**
75-
76-
**Performance Considerations**
77-
<!-- Describe any performance implications -->
78-
79-
## Alternatives Considered (Optional)
80-
81-
<!-- Describe any alternative solutions or features you've considered -->
82-
83-
## Additional Context (Optional)
84-
85-
<!-- Add any other context, mockups, diagrams, or examples -->
86-
87-
**Related Issues/PRs**
88-
<!-- Link to any related issues or pull requests -->
42+
# References (Optional)
43+
<!-- TIPs, papers, related issues, prior art -->
8944

90-
**References**
91-
<!-- Link to any relevant documentation, specifications, or discussions -->
45+
# Additional Notes
46+
- Do you have ideas regarding implementation? Yes / No
47+
- Are you willing to implement this feature? Yes / No

0 commit comments

Comments
 (0)