Skip to content

Commit bb1d66c

Browse files
kuny0707kuny0707
authored
Merge pull request #111 from abn2357/fix_issue_template
fix(docs): issue template
2 parents 5d919e0 + 6b7225d commit bb1d66c

3 files changed

Lines changed: 137 additions & 40 deletions

File tree

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

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,39 @@
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-
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+
-->
19+
20+
## Question
21+
22+
<!-- Clearly describe what you need clarification on -->
23+
24+
## Context
25+
26+
<!-- Provide relevant context that helps us understand your question -->
27+
28+
**What are you trying to achieve?**
29+
<!-- Describe your goal or use case -->
30+
31+
**What have you tried so far?**
32+
<!-- List any approaches or solutions you've attempted -->
33+
34+
**Relevant documentation or code**
35+
<!-- Link to relevant documentation, code sections, or examples -->
36+
37+
## Additional Information
38+
39+
<!-- Any other details that might be helpful -->

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

Lines changed: 35 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,59 @@
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

1010
<!-- Have you done the following? -->
1111
<!-- * 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 -->
12+
<!-- * Duplicate Issue check: https://github.com/search?q=+is%3Aissue+repo%3Atronprotocol/tron-docker -->
1313

14-
#### Software Versions
15-
<!-- `java -jar FullNode.jar -v` -->
1614

17-
<!--
18-
```
19-
OS : Linux
20-
JVM : Oracle Corporation 1.8.0_161 amd64
21-
Git : b1fc2f0f2bd79527099bc3027b9aba165c2e20c2
22-
Version : 4.7.4
23-
Code : 18260
24-
```
25-
-->
15+
## Expected behaviour
2616

27-
#### Expected behaviour
2817
<!--[What you expect to happen] -->
2918

19+
## Actual behaviour
3020

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

23+
## Frequency
3424

35-
#### Frequency
3625
<!-- [What percentage of the time does it occur?] -->
26+
- [ ] Always (100%)
27+
- [ ] Frequently (>50%)
28+
- [ ] Sometimes (10-50%)
29+
- [ ] Rarely (<10%)
30+
31+
## Steps to reproduce the behaviour
32+
<!-- Provide detailed steps to reproduce the issue -->
33+
34+
1.
35+
2.
36+
3.
37+
38+
## Logs and Error Messages
39+
40+
<!--
41+
⚠️ IMPORTANT: Submit logs as text, not screenshots
42+
-->
43+
44+
```
45+
[Paste error messages, stack traces, or relevant logs here]
46+
```
3747

38-
#### Steps to reproduce the behaviour
48+
## Additional Context
3949

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

44-
#### Backtrace
52+
**Screenshots**
53+
<!-- If applicable, add screenshots to help explain the problem -->
4554

46-
````
47-
[backtrace]
48-
````
55+
**Related Issues**
56+
<!-- Link to any related issues or pull requests -->
4957

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

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

Lines changed: 69 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,86 @@
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+
## Background
1211

13-
Why should this feature exist?
12+
<!-- Describe the context and motivation for this feature request -->
1413

15-
What are the use-cases?
14+
## Problem Statement
1615

17-
# Specification
16+
<!-- What problem does this feature solve? What pain points does it address? -->
1817

19-
# Test Specification
18+
## Rationale
2019

21-
# Scope Of Impact
20+
**Why should this feature exist?**
21+
<!-- Explain the benefits and value this feature would provide -->
2222

23+
**What are the use cases?**
24+
<!-- Describe specific scenarios where this feature would be useful -->
2325

24-
# Implementation
26+
1.
27+
2.
28+
3.
2529

26-
Do you have ideas regarding the implementation of this feature?
30+
## Proposed Solution
2731

28-
Are you willing to implement this feature?
32+
<!-- Describe your proposed solution in detail -->
33+
34+
### Specification
35+
36+
<!-- Provide technical specifications or requirements -->
37+
38+
## Test Specification
39+
40+
<!-- How should this feature be tested? -->
41+
42+
**Test Scenarios**
43+
44+
1.
45+
2.
46+
3.
47+
48+
**Performance Considerations**
49+
<!-- Describe any performance implications -->
50+
51+
## Scope Of Impact
52+
53+
<!-- What parts of the system will be affected? -->
54+
55+
## Implementation
56+
57+
**Do you have ideas regarding the implementation?**
58+
<!-- Share any technical approaches or implementation details -->
59+
60+
**Are you willing to implement this feature?**
61+
<!-- Let us know if you'd like to contribute the implementation -->
62+
- [ ] Yes, I can implement this feature
63+
- [ ] I can help with implementation
64+
- [ ] I need help with implementation
65+
- [ ] I'm just suggesting the idea
66+
67+
**Estimated Complexity**
68+
<!-- Your assessment of implementation complexity -->
69+
- [ ] Low (minor changes)
70+
- [ ] Medium (moderate changes)
71+
- [ ] High (significant changes)
72+
- [ ] Unknown
73+
74+
## Alternatives Considered
75+
76+
<!-- Describe any alternative solutions or features you've considered -->
77+
78+
## Additional Context
79+
80+
<!-- Add any other context, mockups, diagrams, or examples -->
81+
82+
**Related Issues/PRs**
83+
<!-- Link to any related issues or pull requests -->
84+
85+
**References**
86+
<!-- Link to any relevant documentation, specifications, or discussions -->

0 commit comments

Comments
 (0)