From e09522c3f2a7668fd733f81530b1b087525f3795 Mon Sep 17 00:00:00 2001 From: GrapeS Date: Fri, 27 Feb 2026 17:11:04 +0800 Subject: [PATCH] format --- .github/ISSUE_TEMPLATE/ask-a-question.md | 21 ++++---- .github/ISSUE_TEMPLATE/report-a-bug.md | 33 +++++------- .github/ISSUE_TEMPLATE/request-a-feature.md | 60 ++++++++------------- 3 files changed, 46 insertions(+), 68 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/ask-a-question.md b/.github/ISSUE_TEMPLATE/ask-a-question.md index f785d28610f..fb630ff46dc 100644 --- a/.github/ISSUE_TEMPLATE/ask-a-question.md +++ b/.github/ISSUE_TEMPLATE/ask-a-question.md @@ -24,31 +24,28 @@ These channels provide faster responses for general inquiries. ## Question -[Clearly describe what you need clarification on] + ## Context -[Provide relevant context that helps us understand your question] + **What are you trying to achieve?** - -[Describe your goal or use case] + **What have you tried so far?** - -[List any approaches or solutions you've attempted] + **Relevant documentation or code** - -[Link to relevant documentation, code sections, or examples] + ## Environment (if applicable) -- Java-tron version: [e.g., 4.7.4] -- Operating System: [e.g., Ubuntu 20.04] -- Java version: [e.g., OpenJDK 1.8.0_161] +- Java-tron version: +- Operating System: +- Java version: ## Additional Information -[Any other details that might be helpful] + diff --git a/.github/ISSUE_TEMPLATE/report-a-bug.md b/.github/ISSUE_TEMPLATE/report-a-bug.md index a08e60b97cb..3ef08a0dee2 100644 --- a/.github/ISSUE_TEMPLATE/report-a-bug.md +++ b/.github/ISSUE_TEMPLATE/report-a-bug.md @@ -16,33 +16,31 @@ assignees: '' ## Bug Description -[Provide a clear and concise description of the bug] + ## Environment **Software Versions** - -Run `java -jar FullNode.jar -v` to get version information: + ``` -OS: [e.g., Ubuntu 20.04, macOS 12.0, Windows 11] -JVM: [e.g., Oracle Corporation 1.8.0_161 amd64] -Git Commit: [e.g., b1fc2f0f2bd79527099bc3027b9aba165c2e20c2] -Version: [e.g., 4.7.4] -Code: [e.g., 18260] +OS: +JVM: +Git Commit: +Version: +Code: ``` **Configuration** - -[If relevant, describe your node configuration (e.g., FullNode, SolidityNode, witness settings)] + ## Expected Behavior -[Describe what you expected to happen] + ## Actual Behavior -[Describe what actually happened] + ## Frequency @@ -73,16 +71,13 @@ Include relevant logs from FullNode.jar or other components ## Additional Context -[Add any other context about the problem] + **Screenshots** - -[If applicable, add screenshots to help explain the problem] + **Related Issues** - -[Link to any related issues or pull requests] + **Possible Solution** - -[If you have suggestions on how to fix the bug, describe them here] + diff --git a/.github/ISSUE_TEMPLATE/request-a-feature.md b/.github/ISSUE_TEMPLATE/request-a-feature.md index f638d777cdd..0b8d3b3289d 100644 --- a/.github/ISSUE_TEMPLATE/request-a-feature.md +++ b/.github/ISSUE_TEMPLATE/request-a-feature.md @@ -14,53 +14,47 @@ Please provide as much detail as possible to help us evaluate your feature reque ## Background -[Describe the context and motivation for this feature request] + ## Problem Statement -[What problem does this feature solve? What pain points does it address?] + ## Rationale **Why should this feature exist?** - -[Explain the benefits and value this feature would provide] + **What are the use cases?** - -[Describe specific scenarios where this feature would be useful] + 1. 2. 3. **Who would benefit from this feature?** - -[e.g., node operators, developers, end users, validators] + ## Proposed Solution -[Describe your proposed solution in detail] + ### Specification -[Provide technical specifications or requirements] + **API Changes** (if applicable) - -[Describe any new or modified APIs] + **Configuration Changes** (if applicable) - -[Describe any new configuration options] + **Protocol Changes** (if applicable) - -[Describe any changes to the TRON protocol] + ## Testing Strategy -[How should this feature be tested?] + **Test Scenarios** 1. @@ -68,12 +62,11 @@ Please provide as much detail as possible to help us evaluate your feature reque 3. **Performance Considerations** - -[Describe any performance implications] + ## Scope of Impact -[What parts of the system will be affected?] + - [ ] Core protocol - [ ] API/RPC @@ -81,33 +74,28 @@ Please provide as much detail as possible to help us evaluate your feature reque - [ ] Network layer - [ ] Smart contracts - [ ] Documentation -- [ ] Other: [specify] +- [ ] Other: **Breaking Changes** - -[Will this feature introduce any breaking changes?] + **Backward Compatibility** - -[How will this feature maintain backward compatibility?] + ## Implementation **Do you have ideas regarding the implementation?** - -[Share any technical approaches or implementation details] + **Are you willing to implement this feature?** - -[Let us know if you'd like to contribute the implementation] + - [ ] Yes, I can implement this feature - [ ] I can help with implementation - [ ] I need help with implementation - [ ] I'm just suggesting the idea **Estimated Complexity** - -[Your assessment of implementation complexity] + - [ ] Low (minor changes) - [ ] Medium (moderate changes) - [ ] High (significant changes) @@ -115,16 +103,14 @@ Please provide as much detail as possible to help us evaluate your feature reque ## Alternatives Considered -[Describe any alternative solutions or features you've considered] + ## Additional Context -[Add any other context, mockups, diagrams, or examples] + **Related Issues/PRs** - -[Link to any related issues or pull requests] + **References** - -[Link to any relevant documentation, specifications, or discussions] +