Skip to content

Commit 5044c82

Browse files
abn2357abn2357
authored
fix(docs): github issue template (#6572)
1 parent ba73305 commit 5044c82

3 files changed

Lines changed: 208 additions & 42 deletions

File tree

‎.github/ISSUE_TEMPLATE/ask-a-question.md‎

Lines changed: 44 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,51 @@
11
---
22
name: Ask a question
3-
about: Something is unclear
4-
title: ''
3+
about: Something is unclear or needs clarification
4+
title: '[QUESTION] '
55
labels: 'type:docs'
66
assignees: ''
77

88
---
9-
This should only be used in very rare cases e.g. if you are not 100% sure if something is a bug or asking a question that leads to improving the documentation. For general questions please use [Discord](https://discord.gg/cGKSsRVCGm) or [Telegram](https://t.me/TronOfficialDevelopersGroupEn).
109

10+
<!--
11+
⚠️ IMPORTANT: Please read before submitting
12+
13+
This template should only be used in rare cases, such as:
14+
- You're unsure if something is a bug or expected behavior
15+
- Your question could lead to documentation improvements
16+
- You need clarification on technical implementation details
17+
18+
For general questions, please use our community channels:
19+
- Discord: https://discord.gg/cGKSsRVCGm
20+
- Telegram: https://t.me/TronOfficialDevelopersGroupEn
21+
22+
These channels provide faster responses for general inquiries.
23+
-->
24+
25+
## Question
26+
27+
<!-- Clearly describe what you need clarification on -->
28+
29+
## Context
30+
31+
<!-- Provide relevant context that helps us understand your question -->
32+
33+
**What are you trying to achieve?**
34+
<!-- Describe your goal or use case -->
35+
36+
**What have you tried so far?**
37+
<!-- List any approaches or solutions you've attempted -->
38+
39+
**Relevant documentation or code**
40+
<!-- Link to relevant documentation, code sections, or examples -->
41+
42+
## Environment (if applicable)
43+
44+
- Network: <!-- e.g., Mainnet -->
45+
- java-tron version: <!-- e.g., 4.7.4 -->
46+
- Operating System: <!-- e.g., Ubuntu 20.04 -->
47+
- Java version: <!-- e.g., java version "1.8.0_391" -->
48+
49+
## Additional Information
50+
51+
<!-- Any other details that might be helpful -->

‎.github/ISSUE_TEMPLATE/report-a-bug.md‎

Lines changed: 64 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,86 @@
11
---
22
name: Report a bug
33
about: Create a report to help us improve
4-
title: ''
4+
title: '[BUG] '
55
labels: 'type:bug'
66
assignees: ''
77

88
---
99

10-
<!-- Have you done the following? -->
11-
<!-- * Reproduced the issue in the latest version of the software -->
12-
<!-- * Duplicate Issue check: https://github.com/search?q=+is%3Aissue+repo%3Atronprotocol/java-tron -->
10+
<!--
11+
⚠️ Before submitting, please ensure you have:
12+
✓ Reproduced the issue in the latest version of java-tron
13+
✓ Checked for duplicate issues: https://github.com/search?q=+is%3Aissue+repo%3Atronprotocol/java-tron
14+
✓ Reviewed the documentation: https://tronprotocol.github.io/documentation-en/introduction/
15+
-->
1316

14-
#### Software Versions
15-
<!-- `java -jar FullNode.jar -v` -->
17+
## Bug Description
18+
19+
<!-- Provide a clear and concise description of the bug -->
20+
21+
## Environment
22+
23+
**Network**
24+
<!-- Specify the network type: Mainnet, Testnet, or Private network -->
25+
26+
**Software Versions**
27+
<!-- Run `java -jar FullNode.jar -v` to get version information -->
1628

17-
<!--
1829
```
19-
OS : Linux
20-
JVM : Oracle Corporation 1.8.0_161 amd64
21-
Git : b1fc2f0f2bd79527099bc3027b9aba165c2e20c2
22-
Version : 4.7.4
23-
Code : 18260
30+
OS: <!-- e.g., Ubuntu 20.04, macOS 12.0, Windows 11 -->
31+
JVM: <!-- e.g., Oracle Corporation 1.8.0_161 amd64 -->
32+
Git Commit: <!-- e.g., b1fc2f0f2bd79527099bc3027b9aba165c2e20c2 -->
33+
Version: <!-- e.g., 4.7.4 -->
34+
Code: <!-- e.g., 18260 -->
2435
```
25-
-->
2636

27-
#### Expected behaviour
28-
<!--[What you expect to happen] -->
37+
**Configuration**
38+
<!-- If relevant, describe your node configuration (e.g., FullNode, SolidityNode, witness settings) -->
39+
40+
## Expected Behavior
41+
42+
<!-- Describe what you expected to happen -->
2943

44+
## Actual Behavior
3045

31-
#### Actual behaviour
32-
<!--[What you expect to happen] -->
46+
<!-- Describe what actually happened -->
3347

48+
## Frequency
3449

35-
#### Frequency
36-
<!-- [What percentage of the time does it occur?] -->
50+
<!-- How often does this issue occur? -->
51+
- [ ] Always (100%)
52+
- [ ] Frequently (>50%)
53+
- [ ] Sometimes (10-50%)
54+
- [ ] Rarely (<10%)
55+
56+
## Steps to Reproduce
57+
58+
<!-- Provide detailed steps to reproduce the issue -->
59+
60+
1.
61+
2.
62+
3.
63+
64+
## Logs and Error Messages
65+
66+
<!--
67+
⚠️ IMPORTANT: Submit logs as text, not screenshots
68+
Include relevant logs from FullNode.jar or other components
69+
-->
70+
71+
```
72+
[Paste error messages, stack traces, or relevant logs here]
73+
```
3774

38-
#### Steps to reproduce the behaviour
75+
## Additional Context
3976

40-
1. [Step 1]
41-
2. [Step 2]
42-
3. [Step ...]
77+
<!-- Add any other context about the problem -->
4378

44-
#### Backtrace
79+
**Screenshots**
80+
<!-- If applicable, add screenshots to help explain the problem -->
4581

46-
````
47-
[backtrace]
48-
````
82+
**Related Issues**
83+
<!-- Link to any related issues or pull requests -->
4984

50-
When submitting logs: please submit them as text and not screenshots.
85+
**Possible Solution**
86+
<!-- If you have suggestions on how to fix the bug, describe them here -->

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

Lines changed: 100 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,117 @@
11
---
22
name: Request a feature
33
about: Suggest an idea for this project
4-
title: ''
4+
title: '[FEATURE] '
55
labels: 'type:feature'
66
assignees: ''
77

88
---
9-
# Background
109

11-
# Rationale
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+
-->
1214

13-
Why should this feature exist?
15+
## Background
1416

15-
What are the use-cases?
17+
<!-- Describe the context and motivation for this feature request -->
1618

17-
# Specification
19+
## Problem Statement
1820

19-
# Test Specification
21+
<!-- What problem does this feature solve? What pain points does it address? -->
2022

21-
# Scope Of Impact
23+
## Rationale
2224

25+
**Why should this feature exist?**
26+
<!-- Explain the benefits and value this feature would provide -->
2327

24-
# Implementation
28+
**What are the use cases?**
29+
<!-- Describe specific scenarios where this feature would be useful -->
2530

26-
Do you have ideas regarding the implementation of this feature?
31+
1.
32+
2.
33+
3.
2734

28-
Are you willing to implement this feature?
35+
**Who would benefit from this feature?**
36+
<!-- e.g., node operators, developers, end users, validators -->
37+
38+
## Proposed Solution
39+
40+
<!-- Describe your proposed solution in detail -->
41+
42+
### Specification
43+
44+
<!-- Provide technical specifications or requirements -->
45+
46+
**API Changes** (if applicable)
47+
<!-- Describe any new or modified APIs -->
48+
49+
**Configuration Changes** (if applicable)
50+
<!-- Describe any new configuration options -->
51+
52+
**Protocol Changes** (if applicable)
53+
<!-- Describe any changes to the TRON protocol -->
54+
55+
## Testing Strategy
56+
57+
<!-- How should this feature be tested? -->
58+
59+
**Test Scenarios**
60+
61+
1.
62+
2.
63+
3.
64+
65+
**Performance Considerations**
66+
<!-- Describe any performance implications -->
67+
68+
## Scope of Impact
69+
70+
<!-- What parts of the system will be affected? -->
71+
72+
- [ ] Core protocol
73+
- [ ] API/RPC
74+
- [ ] Database
75+
- [ ] Network layer
76+
- [ ] Smart contracts
77+
- [ ] Documentation
78+
- [ ] Other: <!-- specify -->
79+
80+
**Breaking Changes**
81+
<!-- Will this feature introduce any breaking changes? -->
82+
83+
**Backward Compatibility**
84+
<!-- How will this feature maintain backward compatibility? -->
85+
86+
## Implementation
87+
88+
**Do you have ideas regarding the implementation?**
89+
<!-- Share any technical approaches or implementation details -->
90+
91+
**Are you willing to implement this feature?**
92+
<!-- Let us know if you'd like to contribute the implementation -->
93+
- [ ] Yes, I can implement this feature
94+
- [ ] I can help with implementation
95+
- [ ] I need help with implementation
96+
- [ ] I'm just suggesting the idea
97+
98+
**Estimated Complexity**
99+
<!-- Your assessment of implementation complexity -->
100+
- [ ] Low (minor changes)
101+
- [ ] Medium (moderate changes)
102+
- [ ] High (significant changes)
103+
- [ ] Unknown
104+
105+
## Alternatives Considered
106+
107+
<!-- Describe any alternative solutions or features you've considered -->
108+
109+
## Additional Context
110+
111+
<!-- Add any other context, mockups, diagrams, or examples -->
112+
113+
**Related Issues/PRs**
114+
<!-- Link to any related issues or pull requests -->
115+
116+
**References**
117+
<!-- Link to any relevant documentation, specifications, or discussions -->

0 commit comments

Comments
 (0)