From 6d1c8fd19451923b877c93407da404a87b9bacc4 Mon Sep 17 00:00:00 2001
From: Edward <dongdongsunny@hotmail.com>
Date: Fri, 10 Jan 2025 11:42:28 +0800
Subject: [PATCH] feat: add GitHub issue template (#5)

* update private net readme
* add issue template
---
 .github/ISSUE_TEMPLATE/ask-a-question.md    | 10 +++++
 .github/ISSUE_TEMPLATE/report-a-bug.md      | 50 +++++++++++++++++++++
 .github/ISSUE_TEMPLATE/request-a-feature.md | 28 ++++++++++++
 .github/PULL_REQUEST_TEMPLATE.md            | 12 +++++
 private_net/README.md                       |  2 +-
 5 files changed, 101 insertions(+), 1 deletion(-)
 create mode 100644 .github/ISSUE_TEMPLATE/ask-a-question.md
 create mode 100644 .github/ISSUE_TEMPLATE/report-a-bug.md
 create mode 100644 .github/ISSUE_TEMPLATE/request-a-feature.md
 create mode 100644 .github/PULL_REQUEST_TEMPLATE.md

diff --git a/.github/ISSUE_TEMPLATE/ask-a-question.md b/.github/ISSUE_TEMPLATE/ask-a-question.md
new file mode 100644
index 0000000..e503998
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/ask-a-question.md
@@ -0,0 +1,10 @@
+---
+name: Ask a question
+about: Something is unclear
+title: ''
+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).
+
diff --git a/.github/ISSUE_TEMPLATE/report-a-bug.md b/.github/ISSUE_TEMPLATE/report-a-bug.md
new file mode 100644
index 0000000..a0d6812
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/report-a-bug.md
@@ -0,0 +1,50 @@
+---
+name: Report a bug
+about: Create a report to help us improve
+title: ''
+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 -->
+
+#### Software Versions
+<!-- `java -jar FullNode.jar -v` -->
+
+<!-- 
+```
+OS : Linux
+JVM : Oracle Corporation 1.8.0_161 amd64
+Git : b1fc2f0f2bd79527099bc3027b9aba165c2e20c2
+Version : 4.7.4
+Code : 18260
+```
+-->
+
+#### Expected behaviour
+<!--[What you expect to happen] -->
+
+
+#### Actual behaviour
+<!--[What you expect to happen] -->
+
+
+#### Frequency
+<!-- [What percentage of the time does it occur?] -->
+
+#### Steps to reproduce the behaviour
+
+1. [Step 1]
+2. [Step 2]
+3. [Step ...]
+
+#### Backtrace
+
+````
+[backtrace]
+````
+
+When submitting logs: please submit them as text and not screenshots.
diff --git a/.github/ISSUE_TEMPLATE/request-a-feature.md b/.github/ISSUE_TEMPLATE/request-a-feature.md
new file mode 100644
index 0000000..261f108
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/request-a-feature.md
@@ -0,0 +1,28 @@
+---
+name: Request a feature
+about: Suggest an idea for this project
+title: ''
+labels: 'type:feature'
+assignees: ''
+
+---
+# Background
+
+# Rationale
+
+Why should this feature exist?
+
+What are the use-cases?
+
+# Specification
+
+# Test Specification
+
+# Scope Of Impact
+
+
+# Implementation
+
+Do you have ideas regarding the implementation of this feature?
+
+Are you willing to implement this feature?
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..7166b09
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,12 @@
+**What does this PR do?**
+
+**Why are these changes required?**
+
+**This PR has been tested by:**
+- Unit Tests
+- Manual Testing
+
+**Follow up**
+
+**Extra details**
+
diff --git a/private_net/README.md b/private_net/README.md
index c9257d5..8f5486a 100644
--- a/private_net/README.md
+++ b/private_net/README.md
@@ -21,7 +21,7 @@ Please download and install the latest version of Docker from the official Docke
 Then check the Docker resource settings to ensure it has at least 12GB of memory per TRON node.
 
 ## Quick-Start using Docker
-Download the folder [private_net](../private_net) and [docker-compose.yml](./docker-compose.yml) from GitHub. Enter the directory and run the docker-composer.
+Download the folder [private_net](../private_net) from GitHub. Enter the directory and run the docker-composer.
 ```
 cd ./private_net
 docker-compose up -d