Skip to content

Latest commit

 

History

History
57 lines (35 loc) · 3.43 KB

CONTRIBUTING.md

File metadata and controls

57 lines (35 loc) · 3.43 KB
Raw

Contributing to this adapter

The community is what makes Sails/Waterline great, without you we wouldn't have come so far. But to help us keep our sanity and reach code-nirvana together, please follow these quick rules whenever contributing.

Opening issues

  1. If you have a question about setting up/using adapters in general, please check out the Sails docs or try searching StackOverflow.
  2. Search for issues similar to yours in GitHub search and Google.
  3. Feature requests are welcome (although pull requests are always better!), but we would prefer to keep them separate from actual issues with the adapter. If you want to submit a feature request, please prefix the name of your issue w/ "Feature Request:", e.g. "Feature Request: blah blah.."
  4. If there's an open issue, please contribute to the discussion in that issue.
  5. If a closed issue has re-emerged, open a new issue and link the url of the already closed issue(s).
  6. If there is no issue, open a new issue and specify the following:
  • A short description of your issue in the title
  • The version of the adapter you're using (check your package.json or node_modules/**/package.json).
  • Detailed explanation of how to recreate the issue.
  1. If you are experiencing more than one problem, please create a separate issue for each one. If you think they might be related, reference the other relevant issues you've created.

Submitting Pull Requests

Get Set Up

Clone this repository, cd into it, and run npm install.

Run Tests

To run tests:

$ npm test

Submit a Pull Request

  1. If you don't know how to fork and PR, have a look at Github's instructions.
  2. Check that someone else hasn't already starting working on your patch (i.e. search issues and PRs.) There might be an open pull request, issue, or closed pull request you can reference.
  3. Fork the repo.
  4. Add a test for your change. Only refactoring and documentation changes require no new tests. If you are adding functionality or fixing a bug, we need a test to ensure the patch can be quickly merged.
  5. Make the tests pass and make sure you follow our syntax guidelines.
  6. Push to your fork and submit a pull request to the master branch.

Tests are written with mocha. Integration tests are handled by the waterline-adapter-tests project, which tests adapter methods against the latest Waterline API.

Additional Resources

Waterline Core on Github | Official Sails Documentation | #sailsjs on IRC | Google Group | Twitter