Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: report bug #35

Merged
merged 1 commit into from
Dec 18, 2024
+56 −0
Merged

docs: report bug #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions bug-report.mdx
View file
Open in desktop
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)**
5 changes: 5 additions & 0 deletions home.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,9 @@ description: "Welcome to TRUF Network Docs"
iconType="solid"
href="/bounties-overview"
></Card>
<Card
title="Bug Report"
icon="bug"
href="/bug-report"
></Card>
</CardGroup>
4 changes: 4 additions & 0 deletions mint.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
Expand Down