Skip to content
This repository has been archived by the owner on Jan 27, 2021. It is now read-only.

Latest commit

 

History

History
50 lines (36 loc) · 3.04 KB

CONTRIBUTING.md

File metadata and controls

50 lines (36 loc) · 3.04 KB
Raw

Contributing to redux-dynamic-reducer

The following is a set of guidelines for contributing to redux-dynamic-reducer, which are hosted in the IOOF Holdings Limited Organization on GitHub. These are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table of Contents

How Can I Contribute?

Reporting Bugs

Bugs are tracked as GitHub issues. Please check to see if your issue has already been raised before submitting your bug report.

When submitting a bug report, please include as much information as possible to help contributors to identify the cause of the problem. The ideal bug report would include:

  • A clear and descriptive title for the issue to identify the problem.
  • A description of the exact scenario to reproduce the problem in as much detail as possible.
  • An explanation of the behaviour you expected to see instead and why.
  • An example to demonstrate the scenario such as:
    • Include copy/pastable snippets (using markdown) in your bug report.
    • Links to files in GitHub or other public repository.
    • Submit a pull request with an example highlighting the issue.
  • Environment details such as:
    • Browser(s) you have seen the problem in.
    • Version of redux-dynamic-reducer you are using.
    • Which Redux middleware (including version numbers) are being used.
    • What other packages (including version numbers) are being used.

Suggesting Enhancements

Enhancements are tracked as GitHub issues. Please check to see if your suggestion has already been made before submitting your suggestion.

When submitting an enhancement submission, please include as much information as possible to help contributors to understand an implement your idea. The ideal enhancement suggestion would include:

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • A description of the specifics of your suggestion in as much detail as possible.
  • An explanation of the benefits implementing your enhancement would provide
  • An example to demonstrate the scenario such as:
    • Include copy/pastable snippets (using markdown) in your enhancement submission.
    • Links to files in GitHub or other public repository.
    • Submit a pull request with an example showing how your enhancement would be used.

Pull Requests

If you want to get your hands dirty, please take a look at the open issues and submit a pull request with your proposed solution, referencing the issue in commit message.