CONTRIBUTING.md

Contribution Guide

Hello 👋!

Thank you for viewing our Contribution Guide. We're grateful for your help, and we're excited you're here.

Feel free to take a moment to view our Code of Conduct as well.

Primary Goals for `redux-wasp

1 - Interoperable: Reduce the stress of calling GraphQL endpoints from a Redux codebase

2 - Small: Avoid bringing in unnecessary dependencies

3 - Easy: Maintain an intuitive, predictable API

Ways to get involved

• Report Issues or Offer Suggestions

• Send a Pull Request with

  • Improve our documentation!
  • Bug fixes
  • More tests
  • New features (please submit an Issue first to make sure it fits the project scope)

Contributing Code

Git Workflow (more information)

All contributions must be offered via Pull Request and be approved by a maintainer.

Make all pull requests to the master branch.

Code Style

There's no need to worry about style. Prettier has been configured, and it'll auto-format your code as soon as it's committed.

See the Airbnb Style Guide for more information.

Javascript/ES Version

• All release code should be as ES5-compatible as possible (with no build tools required)
• All dev-only code should at least be compatible with Node.js v6
  • Includes many common ES6 features such as const and let
  • Does not include class or import syntax

Continuous Integration (CI)

• Write tests for your code
• Pass the test for your code
• Add more tests to other people's code

We're running Jest for our test suite.

Available commands:

• yarn test / npm test to run all tests
• yarn test:watch / npm run test:watch to run the test watcher
• yarn test:coverage / npm run test:coverage to generate a coverage report

---

View the Changelog

Return to README