Contribute Through Bug Reporting

Prev Next

We're thrilled to have you here! To ensure a smooth and efficient bug-reporting process, we've put together this guide. Please take a moment to familiarize yourself with our practices and procedures.

Identifying bugs

Before you proceed, it's crucial to ascertain whether what you're encountering is indeed a bug. If you're struggling to understand how to perform a task, experiencing problems accessing your server, unable to install the server, or want a new widget in Rocket.Chat, these are not considered bugs.

If your concern aligns with the non-bug category, refer to the provided resources in our documentation. Suggestions for new features should be submitted in the forums.

Before reporting a bug

Before you report a new issue:

  • Thoroughly read the documentation.

  • Ensure you're running the latest version of Rocket.Chat. An update might resolve your issue.

  • Try to identify reproducible steps. If we can reproduce it, we can fix it faster.

  • Check all your logs for errors.

  • Search the forums using a few different search terms.

  • Search the issues for your bug. If you find it, carefully check that it is identical and give it a thumbs up. If it differs, add some additional information to the ticket. This will help give us a fuller picture.

Proceed if you've done all of the above and still need to report a bug.

How to report a bug?

Giving clear background information will help save a lot of time. When reporting a new bug, include the following information to promote effective bug fixing:

  • Operating system/version/architecture (64-bit?)

  • Browser type and version, including any add-ons. (e.g., AdBlocker, NoScript, etc.)

  • Rocket.Chat version

  • Expected behavior

  • Actual behavior

  • Steps to reproduce the bug consistently

  • Relevant errors and other log output

  • Screenshots, if applicable

You can register your bug at the following places based on the platform you're using:

Rocket.Chat server

Rocket.Chat mobile apps

Rocket.Chat Electron desktop app

Determining Rocket.Chat version

You can find your Rocket.Chat version in two ways:

  • As an Admin, log into you r Rocket.Chat. Navigate to Manage > Workspace > Info

  • Append /api/info to your Rocket.Chat URL

Gathering logs

  • Browser logs: To collect logs from your browser, press Ctrl/Cmd + Shift + j. Errors will appear in red.

  • Server logs: Refer to the Monitor Workspace Logs and Metrics guide for details.

We appreciate your effort in helping us improve our software. Thank you for your contribution!