diff --git a/.github/ISSUE_TEMPLATE/ask-a-question.md b/.github/ISSUE_TEMPLATE/ask-a-question.md index e503998b477..70c957fe92f 100644 --- a/.github/ISSUE_TEMPLATE/ask-a-question.md +++ b/.github/ISSUE_TEMPLATE/ask-a-question.md @@ -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). + + +## Question + + + +## Context + + + +**What are you trying to achieve?** + + +**What have you tried so far?** + + +**Relevant documentation or code** + + +## Environment (if applicable) + +- Network: +- java-tron version: +- Operating System: +- Java version: + +## Additional Information + + diff --git a/.github/ISSUE_TEMPLATE/report-a-bug.md b/.github/ISSUE_TEMPLATE/report-a-bug.md index a0d68121565..a00d6a51dee 100644 --- a/.github/ISSUE_TEMPLATE/report-a-bug.md +++ b/.github/ISSUE_TEMPLATE/report-a-bug.md @@ -1,50 +1,86 @@ --- name: Report a bug about: Create a report to help us improve -title: '' +title: '[BUG] ' labels: 'type:bug' assignees: '' --- - - - + -#### Software Versions - +## Bug Description + + + +## Environment + +**Network** + + +**Software Versions** + - +JVM: +Git Commit: +Version: +Code: ``` ---> -#### Expected behaviour - +**Configuration** + + +## Expected Behavior + + +## Actual Behavior -#### Actual behaviour - + +## Frequency -#### Frequency - + +- [ ] Always (100%) +- [ ] Frequently (>50%) +- [ ] Sometimes (10-50%) +- [ ] Rarely (<10%) + +## Steps to Reproduce + + + +1. +2. +3. + +## Logs and Error Messages + + + +``` +[Paste error messages, stack traces, or relevant logs here] +``` -#### Steps to reproduce the behaviour +## Additional Context -1. [Step 1] -2. [Step 2] -3. [Step ...] + -#### Backtrace +**Screenshots** + -```` -[backtrace] -```` +**Related Issues** + -When submitting logs: please submit them as text and not screenshots. +**Possible Solution** + diff --git a/.github/ISSUE_TEMPLATE/request-a-feature.md b/.github/ISSUE_TEMPLATE/request-a-feature.md index 261f1088ded..b7f456cf263 100644 --- a/.github/ISSUE_TEMPLATE/request-a-feature.md +++ b/.github/ISSUE_TEMPLATE/request-a-feature.md @@ -1,28 +1,117 @@ --- name: Request a feature about: Suggest an idea for this project -title: '' +title: '[FEATURE] ' labels: 'type:feature' assignees: '' --- -# Background -# Rationale + -Why should this feature exist? +## Background -What are the use-cases? + -# Specification +## Problem Statement -# Test Specification + -# Scope Of Impact +## Rationale +**Why should this feature exist?** + -# Implementation +**What are the use cases?** + -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?** + + +## Proposed Solution + + + +### Specification + + + +**API Changes** (if applicable) + + +**Configuration Changes** (if applicable) + + +**Protocol Changes** (if applicable) + + +## Testing Strategy + + + +**Test Scenarios** + +1. +2. +3. + +**Performance Considerations** + + +## Scope of Impact + + + +- [ ] Core protocol +- [ ] API/RPC +- [ ] Database +- [ ] Network layer +- [ ] Smart contracts +- [ ] Documentation +- [ ] Other: + +**Breaking Changes** + + +**Backward Compatibility** + + +## Implementation + +**Do you have ideas regarding the implementation?** + + +**Are you willing to implement this feature?** + +- [ ] Yes, I can implement this feature +- [ ] I can help with implementation +- [ ] I need help with implementation +- [ ] I'm just suggesting the idea + +**Estimated Complexity** + +- [ ] Low (minor changes) +- [ ] Medium (moderate changes) +- [ ] High (significant changes) +- [ ] Unknown + +## Alternatives Considered + + + +## Additional Context + + + +**Related Issues/PRs** + + +**References** +