Skip to content

Reporting issues

Rand McKinney edited this page Feb 18, 2015 · 29 revisions

This is a guide on what to do when you run into issues while using LoopBack.

  1. Determine the issue type
  2. Report the issue using an appropriate channel
  3. Wait for a response

####1. Determine the issue type

There are three basic types of issues:

#####Question

For the quickest response, ask questions in one of these forums instead of opening an issue:

  • Google Groups
  • StackOverflow
  • Gitter - While we support questions through Gitter, we prefer posting to Google Groups so others may benefit from the discussions.

These are the only channels we officially support. Other channels (such as IRC) are NOT supported.

#####Feature/enhancement request

Open a new GitHub issue at https://github.com/strongloop/loopback/issues.

For feature/enhancement requests related to specific LoopBack dependencies (for example, loopback-connector-mysql), please create an issue in the repository itself (for example, https://github.com/strongloop/loopback-connector-mysql/issues).

#####Bug report

To report a bug:

  1. Fork loopback-sandbox.
  2. Add the code required to reproduce your issue in the forked repository.
  3. Create an issue in the appropriate repository with STR (steps to reproduce) in the issue description AND a link to the forked repository.

From this point, we will clone the the forked repository and try to reproduce the issue on our own machines. Once verified, we will respond to you and prioritize the fix accordingly.

We recommend forking with STR in order to leverage community support in reproducing issues. By doing this, we can focus on fixing and responding to the actual issues.

We give priority to issues that follow the above process, that is, those with a forked repository for us to clone and clear STR.

For bug reports related to specific LoopBack dependencies (for example, loopback-connector-mysql), please create an issue in the repository itself (for example, https://github.com/strongloop/loopback-connector-mysql/issues).

####2. Report the issue using an appropriate channel

We officially support multiple channels for specific purposes. Please choose the SINGLE most appropriate channel to report your issue to.

Please try your best to post issues to the correct repository (ie. post boot related issues to loopback-boot, REST and remoting related issues to strong-remoting, etc). If you cannot determine which project to report the issue to, post the issue in the LoopBack repository itself.

####3. Wait for a response

We actively monitor the officially supported channels and generally respond as soon as possible. If you haven't received a response from us within two days, please remind us on Google Groups or ping us on Gitter.

If your issue turns out to be a question, you will be asked to post on the Google Group mailing list instead. We will then tag the issue with the question label and close it immediately.

We also encourage community participation with regards to resolving issues. If you know the answer to any issues you encounter, please chime in and help each other out. We will also try our best to help users who are actively helping other users.

Clone this wiki locally