Thank you for your interest in supporting Sails! It makes us feel warm and fuzzy inside.
To keep Sails.js as awesome as possible, we need to have a few guidelines for contributions to the framework.
The following are required for code submissions to be considered:
- Must be presented in the form of a Pull Request to Development Branch.
- Must have accompanying tests.
- Must follow Sails.js JShint Guidelines (See .jshint file in repo)
Any pull request that is done to the Master branch will immediately be closed and asked to resubmit to the development branch. We apologize for this; however, we want to keep master at a build state of passing at all times, just in case someone wants to use the most up-to-date awesomeness that isn't available in the npm package.
Now that we are all on the same page, lets get to coding!
Start by forking this 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
additional details, see github
Make your enhancements, fix bugs, do your thang.
When you're done, you can commit your fix, push up your code, and then go into github and submit a pull request. We'll look it over and get back to you ASAP.
If you have a project using Sails, and you want to test your new version, please do the following:
In your Sails repo: sudo npm link
In your project repo: npm link sails
Tada! Your project will now be using your forked version. If you're not sure it worked, put some crazy console.log() in the core to make sure. Again, if you've got any issues, hit us up (@sailsjs).