Skip to content

Commit e09522c

Browse files
committed
format
1 parent dd6a238 commit e09522c

3 files changed

Lines changed: 46 additions & 68 deletions

File tree

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

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -24,31 +24,28 @@ These channels provide faster responses for general inquiries.
2424

2525
## Question
2626

27-
[Clearly describe what you need clarification on]
27+
<!-- Clearly describe what you need clarification on -->
2828

2929
## Context
3030

31-
[Provide relevant context that helps us understand your question]
31+
<!-- Provide relevant context that helps us understand your question -->
3232

3333
**What are you trying to achieve?**
34-
35-
[Describe your goal or use case]
34+
<!-- Describe your goal or use case -->
3635

3736
**What have you tried so far?**
38-
39-
[List any approaches or solutions you've attempted]
37+
<!-- List any approaches or solutions you've attempted -->
4038

4139
**Relevant documentation or code**
42-
43-
[Link to relevant documentation, code sections, or examples]
40+
<!-- Link to relevant documentation, code sections, or examples -->
4441

4542
## Environment (if applicable)
4643

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]
44+
- Java-tron version: <!-- e.g., 4.7.4 -->
45+
- Operating System: <!-- e.g., Ubuntu 20.04 -->
46+
- Java version: <!-- e.g., OpenJDK 1.8.0_161 -->
5047

5148
## Additional Information
5249

53-
[Any other details that might be helpful]
50+
<!-- Any other details that might be helpful -->
5451

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

Lines changed: 14 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -16,33 +16,31 @@ assignees: ''
1616

1717
## Bug Description
1818

19-
[Provide a clear and concise description of the bug]
19+
<!-- Provide a clear and concise description of the bug -->
2020

2121
## Environment
2222

2323
**Software Versions**
24-
25-
Run `java -jar FullNode.jar -v` to get version information:
24+
<!-- Run `java -jar FullNode.jar -v` to get version information -->
2625

2726
```
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]
27+
OS: <!-- e.g., Ubuntu 20.04, macOS 12.0, Windows 11 -->
28+
JVM: <!-- e.g., Oracle Corporation 1.8.0_161 amd64 -->
29+
Git Commit: <!-- e.g., b1fc2f0f2bd79527099bc3027b9aba165c2e20c2 -->
30+
Version: <!-- e.g., 4.7.4 -->
31+
Code: <!-- e.g., 18260 -->
3332
```
3433

3534
**Configuration**
36-
37-
[If relevant, describe your node configuration (e.g., FullNode, SolidityNode, witness settings)]
35+
<!-- If relevant, describe your node configuration (e.g., FullNode, SolidityNode, witness settings) -->
3836

3937
## Expected Behavior
4038

41-
[Describe what you expected to happen]
39+
<!-- Describe what you expected to happen -->
4240

4341
## Actual Behavior
4442

45-
[Describe what actually happened]
43+
<!-- Describe what actually happened -->
4644

4745
## Frequency
4846

@@ -73,16 +71,13 @@ Include relevant logs from FullNode.jar or other components
7371

7472
## Additional Context
7573

76-
[Add any other context about the problem]
74+
<!-- Add any other context about the problem -->
7775

7876
**Screenshots**
79-
80-
[If applicable, add screenshots to help explain the problem]
77+
<!-- If applicable, add screenshots to help explain the problem -->
8178

8279
**Related Issues**
83-
84-
[Link to any related issues or pull requests]
80+
<!-- Link to any related issues or pull requests -->
8581

8682
**Possible Solution**
87-
88-
[If you have suggestions on how to fix the bug, describe them here]
83+
<!-- If you have suggestions on how to fix the bug, describe them here -->

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

Lines changed: 23 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -14,117 +14,103 @@ Please provide as much detail as possible to help us evaluate your feature reque
1414

1515
## Background
1616

17-
[Describe the context and motivation for this feature request]
17+
<!-- Describe the context and motivation for this feature request -->
1818

1919
## Problem Statement
2020

21-
[What problem does this feature solve? What pain points does it address?]
21+
<!-- What problem does this feature solve? What pain points does it address? -->
2222

2323
## Rationale
2424

2525
**Why should this feature exist?**
26-
27-
[Explain the benefits and value this feature would provide]
26+
<!-- Explain the benefits and value this feature would provide -->
2827

2928
**What are the use cases?**
30-
31-
[Describe specific scenarios where this feature would be useful]
29+
<!-- Describe specific scenarios where this feature would be useful -->
3230

3331
1.
3432
2.
3533
3.
3634

3735
**Who would benefit from this feature?**
38-
39-
[e.g., node operators, developers, end users, validators]
36+
<!-- e.g., node operators, developers, end users, validators -->
4037

4138
## Proposed Solution
4239

43-
[Describe your proposed solution in detail]
40+
<!-- Describe your proposed solution in detail -->
4441

4542
### Specification
4643

47-
[Provide technical specifications or requirements]
44+
<!-- Provide technical specifications or requirements -->
4845

4946
**API Changes** (if applicable)
50-
51-
[Describe any new or modified APIs]
47+
<!-- Describe any new or modified APIs -->
5248

5349
**Configuration Changes** (if applicable)
54-
55-
[Describe any new configuration options]
50+
<!-- Describe any new configuration options -->
5651

5752
**Protocol Changes** (if applicable)
58-
59-
[Describe any changes to the TRON protocol]
53+
<!-- Describe any changes to the TRON protocol -->
6054

6155
## Testing Strategy
6256

63-
[How should this feature be tested?]
57+
<!-- How should this feature be tested? -->
6458

6559
**Test Scenarios**
6660
1.
6761
2.
6862
3.
6963

7064
**Performance Considerations**
71-
72-
[Describe any performance implications]
65+
<!-- Describe any performance implications -->
7366

7467
## Scope of Impact
7568

76-
[What parts of the system will be affected?]
69+
<!-- What parts of the system will be affected? -->
7770

7871
- [ ] Core protocol
7972
- [ ] API/RPC
8073
- [ ] Database
8174
- [ ] Network layer
8275
- [ ] Smart contracts
8376
- [ ] Documentation
84-
- [ ] Other: [specify]
77+
- [ ] Other: <!-- specify -->
8578

8679
**Breaking Changes**
87-
88-
[Will this feature introduce any breaking changes?]
80+
<!-- Will this feature introduce any breaking changes? -->
8981

9082
**Backward Compatibility**
91-
92-
[How will this feature maintain backward compatibility?]
83+
<!-- How will this feature maintain backward compatibility? -->
9384

9485
## Implementation
9586

9687
**Do you have ideas regarding the implementation?**
97-
98-
[Share any technical approaches or implementation details]
88+
<!-- Share any technical approaches or implementation details -->
9989

10090
**Are you willing to implement this feature?**
101-
102-
[Let us know if you'd like to contribute the implementation]
91+
<!-- Let us know if you'd like to contribute the implementation -->
10392
- [ ] Yes, I can implement this feature
10493
- [ ] I can help with implementation
10594
- [ ] I need help with implementation
10695
- [ ] I'm just suggesting the idea
10796

10897
**Estimated Complexity**
109-
110-
[Your assessment of implementation complexity]
98+
<!-- Your assessment of implementation complexity -->
11199
- [ ] Low (minor changes)
112100
- [ ] Medium (moderate changes)
113101
- [ ] High (significant changes)
114102
- [ ] Unknown
115103

116104
## Alternatives Considered
117105

118-
[Describe any alternative solutions or features you've considered]
106+
<!-- Describe any alternative solutions or features you've considered -->
119107

120108
## Additional Context
121109

122-
[Add any other context, mockups, diagrams, or examples]
110+
<!-- Add any other context, mockups, diagrams, or examples -->
123111

124112
**Related Issues/PRs**
125-
126-
[Link to any related issues or pull requests]
113+
<!-- Link to any related issues or pull requests -->
127114

128115
**References**
129-
130-
[Link to any relevant documentation, specifications, or discussions]
116+
<!-- Link to any relevant documentation, specifications, or discussions -->

0 commit comments

Comments
 (0)