This guide is designed to get you started contributing to the Sails framework. It assumes basic familiarity with Github, but it should be useful for contributors of all levels.
Like any open-source project, we must have guidelines for contributions—it helps protect the quality of the code and ensures that our framework stays robust and dependable. For these reasons, it's important that contribution protocols are followed for all contributions to Sails, whether they be bug fixes or whole sets of new features.
Before submitting a pull request, please make sure:
.editorconfigfiles in repo).
If you have a high-priority hot-fix for the currently deployed version, please post an issue on Github and mention @mikermcneil. Also, for emergencies, please feel free to tweet @sailsjs.
Now that we are all on the same page, lets get to coding some awesomeness of our own :D
Start by forking the repository:
Then clone your fork into your local filesystem: git clone `[email protected]:YOUR_USER_NAME/sails.git`
To merge recent changes into your fork, inside your project dir:
git remote add core https://github.com/balderdashy/sails.git git fetch core git merge core/master
For additional details, see Github.
Make your enhancements, fix bugs, do your thang.
Please write a test for your addition/fix. I know it kind of sucks if you're not used to it, but it's how we maintain great code.
For our test suite, we use Mocha. You can run the tests with
npm test. See the "Testing" section in the contribution guide for more information.
When you're done, you can commit your fix, push up your changes, and then go into Github and submit a pull request. We'll look it over and get back to you ASAP.
If you forked Sails and you want to test your Sails app against your fork, here's how you do it:
In your local copy of your fork of Sails:
sudo npm link
In your Sails app's repo:
npm link sails
This creates a symbolic link as a local dependency (in your app's
node_modules folder). This has the effect of letting you run your app with the version Sails you
$ sails lift