Permalink
Switch branches/tags
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
58 lines (37 sloc) 1.91 KB

Contributing

Thanks for wanting to contribute to redux-belt! We are very much looking forward to your suggestions, bug reports, and pull requests.

Submitting bug reports

Have a look at our [issue tracker](https://github.com/store2be/redux-belt/issues. If you can't find an issue (open or closed) describing your problem (or a very similar one) there, please open a issue with the following details:

  • Which versions of node, redux, redux-saga and redux-belt are you using?
  • What are you trying to accomplish?
  • What is the full error you are seeing?
  • How can we reproduce this?
    • Please quote as much of your code as needed to reproduce (best link to a public repository or a Gist)

Thank you! We'll try to get back to you as soon as possible.

Submitting feature requests

If you can't find an issue (open or closed) describing your idea on our issue tracker, open an issue. It would be great if you could answer the following questions in your description:

  • What do you want to do and how do you expect redux-belt to support you with that?
  • How do you think this can be added to redux-belt?
  • What are possible alternatives?
  • Are there any disadvantages?

Thank you! We'll try to get back to you as soon as possible.

Contribute code to redux-belt

Setting up redux-belt locally

  1. Install node.
  2. Clone this repository.
  3. Install the dependencies.
  4. Now, try running the test suite to confirm everything works for you locally by executing yarn run test.

Git Commit Guidelines

We use gitmojis for our commit messages. It would be cool if you adapt this when contributing to redux-belt.

Code reviews

All submissions, including submissions by project members, require review. We use Github pull requests for this purpose.

Code of Conduct

See CODE_OF_CONDUCT.md.