Contributing

Contributing to the JSData project

Dear contributor,

Thank you! Projects like this are successful because of you!

Interested in contributing? Let us know on our Slack channel or Mailing list, or comment on a JSData GitHub Issue that interests you. Individual repositories have their own more detailed contributing instructions.

Here are some project needs:

  • Documentation - Need someone to take responsibility for the API Reference documentation
    • JSDoc comments in the source code
    • Manage http://api.js-data.io and sub-sites
    • Improve style, design, usability of API docs
  • Documentation - Need someone to take responsibility for http://js-data.io
    • Create an maintain guides & tutorials
    • Ensure accuracy of reference pages
    • Add examples
  • Reliability - Need someone to help improve reliability of js-data libraries
    • Improve test coverage
    • Write benchmark tests
    • Test integration with webpack, jspm, browserify, require.js, rollup, ES6, TypeScript, etc.
  • Adapters - Need maintainers for:
    • js-data-localstorage, js-data-localforage
    • js-data-redis
    • js-data-nedb, js-data-levelup
  • Adapters - Need someone to write new adapters:
    • js-data-dynamodb
    • js-data-arangodb
    • js-data-cassandra
    • js-data-couchdb
    • js-data-orientdb
    • js-data-riak
    • js-data-elasticsearch
  • Integrations - Need someone to write new libraries:
    • js-data-immutable - Version of DataStore that uses immutable.js instead of being an Identity Map
    • js-data-odata - Component that upgrades js-data + js-data-http to work with OData APIs
    • js-data-hateos - Component that upgrades js-data + js-data-http to work with HATEOS APIs
    • js-data-jsonapi - Component that upgrades js-data + js-data-http to work with JSONAPI APIs
  • Issues/Community/Support
    • Help triage issues
    • Answer support questions
    • Help team know what new features are needed
    • Help team know where documentation isn't good enough