Before asking a question on GitHub
If you have a question about how to do something in LoopBack, follow these steps:
- Consult the documentation and the API documentation. NOTE: The search box above searches both of these sites.
- If you don’t find an answer to your question, then do one of the following:
- Search and then ask on the developer forum / Google group.
- Search and then ask on StackOverflow.
- Ask on Gitter.
Posting to Google Group or StackOverflow is preferred so others may benefit from the answer.
- If the above two ways do not work, open a GitHub issue on the corresponding LoopBack repo, providing as much information as possible, for example, versions and use case scenarios for features.
How to report an issue
To report an issue:
- Search existing issues. It’s possible someone has already reported the same problem.
- Make sure you have a GitHub account.
- Create a new issue for the bug, following the steps outlined below
Determine the issue type
There are three types of issues:
- Questions - Please post to the developer forum (Google Group) instead.
- Feature/enhancement request
- Bug report
We take security vulnerabilities in LoopBack very seriously for our users.
In production, do not enable debug logs that may contain sensitive data; for example, the payload of
PersistedModel.create should not be exposed in production. Logging this type of information is acceptable in development, but not in production.
Do not report security vulnerabilities using GitHub issues. Please send an email to
- Description of the vulnerability.
- Steps to reproduce the issue.
- Possible solutions.
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).
To report a bug:
- Fork loopback-sandbox.
- Add the code required to reproduce your issue in the forked repository.
- Create an issue in the appropriate repository with steps to reproduce (STR) 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. Once verified, we will respond to you and prioritize the fix accordingly.
We recommend forking with STR to leverage community support in reproducing issues. By doing this, we can focus on fixing and responding to the actual issues.
Tip: 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, loopback-connector-mysql.
Key information to include
When reporting bugs, please include at least all the following:
- Operating system version.
- Node.js version.
- Pertinent version of Node modules, for example LoopBack.
- Any stack trace, error message text, or other relevant information.
Consider using NodeReport to gather and report the relevant information.
2. Report in appropriate channel
We support multiple channels for specific purposes. Please choose the SINGLE most appropriate channel to report your issue to.
Post issues to the correct repository (for example, boot-related issues to
loopback-boot, REST and remoting-related issues to
strong-remoting, and so on). If you cannot determine which project to report the issue to, post the issue in the
loopback repository itself.
3. Wait for 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.
Tip: 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.