Skip to content

Commit

Permalink
feat: add GitHub issue template (#5)
Browse files Browse the repository at this point in the history
* update private net readme
* add issue template
  • Loading branch information
Sunny6889 authored Jan 10, 2025
1 parent c29b19b commit 6d1c8fd
Show file tree
Hide file tree
Showing 5 changed files with 101 additions and 1 deletion.
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/ask-a-question.md
Original file line number Diff line number Diff line change
@@ -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).

50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE/report-a-bug.md
Original file line number Diff line number Diff line change
@@ -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.
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/request-a-feature.md
Original file line number Diff line number Diff line change
@@ -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?
12 changes: 12 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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**

2 changes: 1 addition & 1 deletion private_net/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 6d1c8fd

Please # to comment.