Skip to content

Commit aed9bfc

Browse files
Sunny6889Sunny6889
authored
Merge pull request #4 from Sunny6889/fix_github
fix(doc): update issue template and contribution
2 parents d61e134 + 4b949dc commit aed9bfc

4 files changed

Lines changed: 411 additions & 184 deletions

File tree

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

Lines changed: 47 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,54 @@
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).
9+
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+
35+
[Describe your goal or use case]
36+
37+
**What have you tried so far?**
38+
39+
[List any approaches or solutions you've attempted]
40+
41+
**Relevant documentation or code**
42+
43+
[Link to relevant documentation, code sections, or examples]
44+
45+
## Environment (if applicable)
46+
47+
- Java-tron version: [e.g., 4.7.4]
48+
- Operating System: [e.g., Ubuntu 20.04]
49+
- Java version: [e.g., OpenJDK 1.8.0_161]
50+
51+
## Additional Information
52+
53+
[Any other details that might be helpful]
1054

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

Lines changed: 66 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,88 @@
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+
**Software Versions**
24+
25+
Run `java -jar FullNode.jar -v` to get version information:
1626

17-
<!--
1827
```
19-
OS : Linux
20-
JVM : Oracle Corporation 1.8.0_161 amd64
21-
Git : b1fc2f0f2bd79527099bc3027b9aba165c2e20c2
22-
Version : 4.7.4
23-
Code : 18260
28+
OS: [e.g., Ubuntu 20.04, macOS 12.0, Windows 11]
29+
JVM: [e.g., Oracle Corporation 1.8.0_161 amd64]
30+
Git Commit: [e.g., b1fc2f0f2bd79527099bc3027b9aba165c2e20c2]
31+
Version: [e.g., 4.7.4]
32+
Code: [e.g., 18260]
2433
```
25-
-->
2634

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

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

31-
#### Actual behaviour
32-
<!--[What you expect to happen] -->
74+
## Additional Context
3375

76+
[Add any other context about the problem]
3477

35-
#### Frequency
36-
<!-- [What percentage of the time does it occur?] -->
78+
**Screenshots**
3779

38-
#### Steps to reproduce the behaviour
80+
[If applicable, add screenshots to help explain the problem]
3981

40-
1. [Step 1]
41-
2. [Step 2]
42-
3. [Step ...]
82+
**Related Issues**
4383

44-
#### Backtrace
84+
[Link to any related issues or pull requests]
4585

46-
````
47-
[backtrace]
48-
````
86+
**Possible Solution**
4987

50-
When submitting logs: please submit them as text and not screenshots.
88+
[If you have suggestions on how to fix the bug, describe them here]

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

Lines changed: 113 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,130 @@
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?**
2326

24-
# Implementation
27+
[Explain the benefits and value this feature would provide]
2528

26-
Do you have ideas regarding the implementation of this feature?
29+
**What are the use cases?**
2730

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

0 commit comments

Comments
 (0)