diff --git a/bug-report.mdx b/bug-report.mdx new file mode 100644 index 0000000..7cb7ee0 --- /dev/null +++ b/bug-report.mdx @@ -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)** diff --git a/home.mdx b/home.mdx index bd908d3..9762005 100644 --- a/home.mdx +++ b/home.mdx @@ -49,4 +49,9 @@ description: "Welcome to TRUF Network Docs" iconType="solid" href="/bounties-overview" > + diff --git a/mint.json b/mint.json index 3b78e51..8283b9a 100644 --- a/mint.json +++ b/mint.json @@ -43,6 +43,10 @@ "group": "Bounties", "pages": ["bounties-overview","data-consumer-guide", "data-provider-guide", "writing-adapters"] }, + { + "group": "Bug Report", + "pages": ["bug-report"] + }, { "group": "Others", "pages": ["terms-of-service", "privacy-policy"]