Guidelines for Reporting Bugs on BugsigDB

[Fificode]

BugsigDB Bug Reporting Guidelines

This guide explains how to report bugs observed on the BugsigDB website. Creating detailed and reproducible bug reports helps developers investigate issues efficiently and track their resolution through GitHub Issues.

The Purpose

The goal of bug reporting is to make issues:

• Easy to understand
• Easy to reproduce
• Easy to track from identification to resolution

Well-documented bug reports help improve communication between curators, contributors, and developers, leading to faster diagnosis and fixes.

Before Reporting a Bug

Before creating a bug report, please:

• Refresh the page and check whether the issue persists.
• Verify that your internet connection is stable.
• Test the issue in another browser, if possible.
• Search existing issues to confirm that the bug has not already been reported.

Creating a Bug Report

When you identify a bug, create a new GitHub Issue and include the information below.

1. Bug Title

Provide a short and descriptive title.

Examples:

• Study page fails to load after clicking "Save Details"
• Navigation menu overlaps content on mobile devices

2. Page URL

Provide the exact URL where the issue occurs.

Example:
https://bugsigdb.org/123456

3. Description

Describe the issue clearly and concisely.

4. Steps to Reproduce

List the exact steps required to reproduce the bug.

Example:

• Go to https://bugsigdb.org/123456
• Create a new experiment
• Enter a value in the sample size field
• Click the Save button

5. Expected Behavior

Describe what should happen.

6. Actual Behavior

Describe what actually happens.

7. Screenshots or Screen Recordings

Attach screenshots or recordings whenever possible to help illustrate the issue.

8. Environment

Please include:
Browser:
Device (Desktop/Mobile/Tablet):
Operating System:

---

Example Bug Report

1. Bug Title

• Sample size is not displayed after clicking the Save button

2. Page URL

• https://bugsigdb.org/123456

3. Description

• After entering a sample size and clicking the Save button, the value is not displayed in the sample size field, making it appear that the information was not saved.

4. Steps to Reproduce

• Go to https://bugsigdb.org/123456
• Create a new experiment
• Enter a value in the sample size field
• Click the save button

5. Expected Behavior

• The inputted sample size should be saved and displayed in the sample size field.

6. Actual Behavior

• The sample size field remains blank after clicking the Save button.

7. Environment

• Browser: Chrome
• Device: Desktop
• Operating System: Windows 11

---

Issue Tracking

• Each reported bug will be tracked through its GitHub Issue. Once a bug has been investigated and resolved, the corresponding issue will be closed.

[Karimatu05]

Hi @Fificode, I’ve created a UX improvement proposal for the BugSigDB Bug Reporting Guidelines in this issue.

I reviewed the existing guideline and focused on making it easier for first-time contributors to understand the reporting process, scan the required information and create complete/reproducible GitHub bug reports.

The proposal includes:

A clearer reporting workflow
Improved information hierarchy
A visual example of a complete bug report
A copyable GitHub issue template

Figma Link: https://www.figma.com/design/xqrhMUkBcwr2i1QnJmgK7e/UX-Improvement-Proposal-for-BugSigDB-Bug-Reporting-Guidelines?node-id=0-1&t=7XTij7TSUOEeu5PA-1

I’d appreciate any feedback on the proposed structure and whether this would be useful for the project.