forked from mintlify/starter
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
56 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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 |
---|---|---|
@@ -0,0 +1,47 @@ | ||
--- | ||
title: Bug Reporting Guide | ||
description: Instructions for reporting bugs in the TRUF Network. | ||
--- | ||
|
||
If you find a bug in the **TRUF Network (TN)** or its related components, please report it in the centralized GitHub Discussions space for bug reports. | ||
|
||
👉 **[Report a Bug Here](https://github.com/trufnetwork/node/discussions/categories/bug-reports)** | ||
|
||
--- | ||
|
||
## Reporting Steps | ||
|
||
1. Go to the [Bug Reports Category](https://github.com/trufnetwork/node/discussions/categories/bug-reports). | ||
2. Open a new discussion and describe the bug clearly. | ||
3. Provide relevant details such as: | ||
- **Version/Commit**: The version or commit hash you’re using if applicable. | ||
- **Operating System**: e.g., Ubuntu 20.04, macOS 13.0. | ||
- **Expected Behavior**: What you expected to happen. | ||
- **Actual Behavior**: What actually happened. | ||
- **Steps to Reproduce**: The steps others can follow to recreate the issue. | ||
- **Additional Information**: Configuration details, logs, or environment context. | ||
|
||
--- | ||
|
||
## Reference Example | ||
|
||
For guidance, you can look at the existing bug report template used across repositories as a **reference**: | ||
|
||
- Include detailed **steps to reproduce** the issue. | ||
- Clearly describe the **expected behavior** vs. **actual behavior**. | ||
- Add logs and relevant configurations as **text** (avoid screenshots). | ||
|
||
**Example**: | ||
|
||
> - **Version/Commit**: `NaN` | ||
> - **Operating System**: `Windows 11` | ||
> - **Expected Behavior**: Numbers displayed correctly in the UI. | ||
> - **Actual Behavior**: Some numbers are missing or displayed as `NaN`. | ||
> - **Steps to Reproduce**: | ||
> 1. Open https://truf-network.vercel.app in the browser. | ||
> 2. Some numbers are missing or displayed as `NaN`. | ||
--- | ||
|
||
## Submit Your Report Here: | ||
👉 **[Centralized Bug Reports Space](https://github.com/trufnetwork/node/discussions/categories/bug-reports)** |
This file contains 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
This file contains 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