41 lines
1.3 KiB
Markdown
41 lines
1.3 KiB
Markdown
|
# Contributing to re-frame
|
||
|
|
|
||
|
|
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
|
||
|
|
|
||
|
|
The following is a set of guidelines for contributing to re-frame which is hosted on [Github](https://github.com/Day8/re-frame).
|
||
|
|
These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.
|
||
|
|
|
||
|
|
## Creating issues for bugs
|
||
|
|
|
||
|
|
Check if the issue has already been reported. If possible provide:
|
||
|
|
|
||
|
|
* Version of re-frame being used
|
||
|
|
* Minimal reproduction steps
|
||
|
|
|
||
|
|
## Creating issues for features
|
||
|
|
|
||
|
|
Use your best judgement on what is needed here.
|
||
|
|
|
||
|
|
## Pull requests
|
||
|
|
|
||
|
|
**Create pull requests to the develop branch**, work will merged onto master when it is ready to be released.
|
||
|
|
|
||
|
|
## Pull requests for bugs
|
||
|
|
|
||
|
|
If possible provide:
|
||
|
|
|
||
|
|
* Code that fixes the bug
|
||
|
|
* Failing tests which pass with the new changes
|
||
|
|
* Improvements to documentation to make it less likely that others will run into issues (if relevant).
|
||
|
|
* Add the change to the Unreleased section of [CHANGES.md](CHANGES.md)
|
||
|
|
|
||
|
|
## Pull requests for features
|
||
|
|
|
||
|
|
If possible provide:
|
||
|
|
|
||
|
|
* Code that implements the new feature
|
||
|
|
* Tests to cover the new feature including all of the code paths
|
||
|
|
* Docstrings for functions
|
||
|
|
* Documentation examples
|
||
|
|
* Add the change to the Unreleased section of [CHANGES.md](CHANGES.md)
|