-
Notifications
You must be signed in to change notification settings - Fork 1.6k
fix(docs): github issue template #6572
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+208
−42
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,51 @@ | ||
| --- | ||
| name: Ask a question | ||
| about: Something is unclear | ||
| title: '' | ||
| about: Something is unclear or needs clarification | ||
| title: '[QUESTION] ' | ||
| labels: 'type:docs' | ||
| assignees: '' | ||
|
|
||
| --- | ||
| 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). | ||
|
|
||
| <!-- | ||
| ⚠️ IMPORTANT: Please read before submitting | ||
|
|
||
| This template should only be used in rare cases, such as: | ||
| - You're unsure if something is a bug or expected behavior | ||
| - Your question could lead to documentation improvements | ||
| - You need clarification on technical implementation details | ||
|
|
||
| For general questions, please use our community channels: | ||
| - Discord: https://discord.gg/cGKSsRVCGm | ||
| - Telegram: https://t.me/TronOfficialDevelopersGroupEn | ||
|
|
||
| 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) | ||
|
|
||
| - Network: <!-- e.g., Mainnet --> | ||
| - java-tron version: <!-- e.g., 4.7.4 --> | ||
| - Operating System: <!-- e.g., Ubuntu 20.04 --> | ||
| - Java version: <!-- e.g., java version "1.8.0_391" --> | ||
|
|
||
| ## Additional Information | ||
|
|
||
| <!-- Any other details that might be helpful --> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,50 +1,86 @@ | ||
| --- | ||
| name: Report a bug | ||
| about: Create a report to help us improve | ||
| title: '' | ||
| title: '[BUG] ' | ||
| labels: 'type:bug' | ||
| assignees: '' | ||
|
|
||
| --- | ||
|
|
||
| <!-- Have you done the following? --> | ||
| <!-- * Reproduced the issue in the latest version of the software --> | ||
| <!-- * Duplicate Issue check: https://github.com/search?q=+is%3Aissue+repo%3Atronprotocol/java-tron --> | ||
| <!-- | ||
| ⚠️ Before submitting, please ensure you have: | ||
| ✓ Reproduced the issue in the latest version of java-tron | ||
| ✓ Checked for duplicate issues: https://github.com/search?q=+is%3Aissue+repo%3Atronprotocol/java-tron | ||
| ✓ Reviewed the documentation: https://tronprotocol.github.io/documentation-en/introduction/ | ||
| --> | ||
|
|
||
| #### Software Versions | ||
| <!-- `java -jar FullNode.jar -v` --> | ||
| ## Bug Description | ||
|
|
||
| <!-- Provide a clear and concise description of the bug --> | ||
|
|
||
| ## Environment | ||
|
|
||
| **Network** | ||
| <!-- Specify the network type: Mainnet, Testnet, or Private network --> | ||
|
|
||
| **Software Versions** | ||
| <!-- Run `java -jar FullNode.jar -v` to get version information --> | ||
|
|
||
| <!-- | ||
| ``` | ||
| OS : Linux | ||
| JVM : Oracle Corporation 1.8.0_161 amd64 | ||
| Git : b1fc2f0f2bd79527099bc3027b9aba165c2e20c2 | ||
| Version : 4.7.4 | ||
| Code : 18260 | ||
| 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 --> | ||
| ``` | ||
| --> | ||
|
|
||
| #### Expected behaviour | ||
| <!--[What you expect to happen] --> | ||
| **Configuration** | ||
| <!-- If relevant, describe your node configuration (e.g., FullNode, SolidityNode, witness settings) --> | ||
|
|
||
| ## Expected Behavior | ||
|
|
||
| <!-- Describe what you expected to happen --> | ||
|
|
||
| ## Actual Behavior | ||
|
|
||
| #### Actual behaviour | ||
| <!--[What you expect to happen] --> | ||
| <!-- Describe what actually happened --> | ||
|
|
||
| ## Frequency | ||
|
|
||
| #### Frequency | ||
| <!-- [What percentage of the time does it occur?] --> | ||
| <!-- How often does this issue occur? --> | ||
| - [ ] Always (100%) | ||
| - [ ] Frequently (>50%) | ||
| - [ ] Sometimes (10-50%) | ||
| - [ ] Rarely (<10%) | ||
|
|
||
| ## Steps to Reproduce | ||
|
|
||
| <!-- Provide detailed steps to reproduce the issue --> | ||
|
|
||
| 1. | ||
| 2. | ||
| 3. | ||
|
|
||
| ## Logs and Error Messages | ||
|
|
||
| <!-- | ||
| ⚠️ IMPORTANT: Submit logs as text, not screenshots | ||
| Include relevant logs from FullNode.jar or other components | ||
| --> | ||
|
|
||
| ``` | ||
| [Paste error messages, stack traces, or relevant logs here] | ||
| ``` | ||
|
|
||
| #### Steps to reproduce the behaviour | ||
| ## Additional Context | ||
|
|
||
| 1. [Step 1] | ||
| 2. [Step 2] | ||
| 3. [Step ...] | ||
| <!-- Add any other context about the problem --> | ||
|
|
||
| #### Backtrace | ||
| **Screenshots** | ||
| <!-- If applicable, add screenshots to help explain the problem --> | ||
|
|
||
| ```` | ||
| [backtrace] | ||
| ```` | ||
| **Related Issues** | ||
| <!-- Link to any related issues or pull requests --> | ||
|
|
||
| When submitting logs: please submit them as text and not screenshots. | ||
| **Possible Solution** | ||
| <!-- If you have suggestions on how to fix the bug, describe them here --> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,28 +1,117 @@ | ||
| --- | ||
| name: Request a feature | ||
| about: Suggest an idea for this project | ||
| title: '' | ||
| title: '[FEATURE] ' | ||
| labels: 'type:feature' | ||
| assignees: '' | ||
|
|
||
| --- | ||
| # Background | ||
|
|
||
| # Rationale | ||
| <!-- | ||
| Thank you for contributing to java-tron! | ||
| Please provide as much detail as possible to help us evaluate your feature request. | ||
| --> | ||
|
|
||
| Why should this feature exist? | ||
| ## Background | ||
|
|
||
| What are the use-cases? | ||
| <!-- Describe the context and motivation for this feature request --> | ||
|
|
||
| # Specification | ||
| ## Problem Statement | ||
|
|
||
| # Test Specification | ||
| <!-- What problem does this feature solve? What pain points does it address? --> | ||
|
|
||
| # Scope Of Impact | ||
| ## Rationale | ||
|
|
||
| **Why should this feature exist?** | ||
| <!-- Explain the benefits and value this feature would provide --> | ||
|
|
||
| # Implementation | ||
| **What are the use cases?** | ||
| <!-- Describe specific scenarios where this feature would be useful --> | ||
|
|
||
| Do you have ideas regarding the implementation of this feature? | ||
| 1. | ||
| 2. | ||
| 3. | ||
|
|
||
| Are you willing to implement this feature? | ||
| **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. | ||
| 2. | ||
| 3. | ||
|
|
||
| **Performance Considerations** | ||
| <!-- Describe any performance implications --> | ||
|
|
||
| ## Scope of Impact | ||
|
|
||
| <!-- What parts of the system will be affected? --> | ||
|
|
||
| - [ ] Core protocol | ||
| - [ ] API/RPC | ||
| - [ ] Database | ||
| - [ ] Network layer | ||
| - [ ] Smart contracts | ||
| - [ ] Documentation | ||
| - [ ] Other: <!-- specify --> | ||
|
|
||
| **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) | ||
| - [ ] Unknown | ||
|
|
||
| ## 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 --> |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
这个例子改成这样的吧,有更详细的版本发行方和版本号,可以提示用户把整个信息复制过来
“e.g., openjdk version "1.8.0_422-internal" ”