When opening new issues or commenting on existing issues in any of the repositories in this GitHub organization, please make sure discussions are related to concrete technical issues of the Sails.js software. Feature requests and ideas are always welcome, but they should not be submitted as GitHub issues. See Requesting Features below for submission guidelines.
If you have found a security vulnerability in Sails or any of its dependencies, do not report it in a public issue. Instead, alert the core maintainers immediately using the instructions detailed in the Sails Security Policy. Please observe this request even for external dependencies not directly maintained by the core Sails.js team (e.g. Socket.io, Express, Node.js, or openssl). Whether or not you believe the core team can do anything to fix an issue, please follow the instructions in our security policy to privately disclose the vulnerability as quickly as possible.
Finally, discussion of a non-technical nature, including subjects like team membership, trademark, code of conduct, and high-level questions or concerns about the project should be sent directly to the core maintainers by emailing inq[email protected].
Sails is composed of a number of different sub-projects, many of which have their own dedicated repository. Even so, the best place to submit a suspected issue with a module maintained by the Sails core team is in the main Sails repo. This helps us stay on top of issues and keep organized.
Before submitting an issue, please follow these simple instructions:
First, search for issues similar to yours in GitHub search within the main Sails repo.
Once you've determined that a new issue should be created,
Make sure your new issue does not report multiple unrelated problems.
Check that your issue has a concise, on-topic title that uses polite, neutral language to explain the problem as best you can in the available space. The ideal title for your issue is one that communicates the problem at a glance.
Before putting together steps to reproduce your issue, normalize as many of the variables on your personal development environment as possible:
npm link foo)
rm -rf node_modules && npm cache clear && npm install.
Remember to provide the version of Sails that your app is using (
Provide your currently-installed version of Node.js (
node -v), your version of NPM (
npm -v), and the operating system that you are running (OS X, Windows, Ubuntu, etc.)
nvmor another Node version manager like
n, please be sure to mention that in the issue.
Provide detailed steps to reproduce the problem from a clean Sails app (i.e. an app created with
sails new on a computer with no special environment variables or
Finally, take a moment to think about what you are about to post and how it will be interpreted by the rest of the Sails userbase. Make sure it is aligned with our Code of Conduct, and make sure you are not endangering other Sails users by posting a security vulnerability publicly.
Issues which do not meet these guidelines will usually be closed without being read, with a response asking that the submitter review this contribution guide. If this happens to you, realize that it's nothing personal, and that it may even happen again. Please understand that Sails is a large project that receives hundreds of new issue submissions every month, and that we truly appreciate the time you donate to post detailed issues. The more familiar you become with the conventions and ground rules laid out in this contribution guide, the more helpful your future contributions will be for the community. You will also earn the respect of core team members and set a good example for future contributors.
You might think of these rules as guardrails on a beautiful mountain road: they may not always be pretty, and if you run into them you may get banged up a little bit, but, collectively, they keep us all from sliding off a turn and into the abyss.