49 lines
1.1 KiB
ReStructuredText
49 lines
1.1 KiB
ReStructuredText
|
|
||
|
|
Project Support
|
||
|
|
---------------
|
||
|
|
|
||
|
|
Contributing
|
||
|
|
========================
|
||
|
|
We welcome all contributors.
|
||
|
|
|
||
|
|
While any code contributions are welcome, areas that could use improvement are:
|
||
|
|
|
||
|
|
* Providing feedback
|
||
|
|
* Email Formating
|
||
|
|
* iReport Library Updates
|
||
|
|
|
||
|
|
|
||
|
|
Issues
|
||
|
|
========================
|
||
|
|
If you've found a bug, let us know.
|
||
|
|
|
||
|
|
Pull Requests
|
||
|
|
========================
|
||
|
|
|
||
|
|
Create a fork of our repo.
|
||
|
|
|
||
|
|
To submit a pull request for a **new feature**:
|
||
|
|
|
||
|
|
1. Run the tests. Every pull request for a new feature should have an accompanying unit test and docs changes.
|
||
|
|
2. Create a new branch off of the `master` branch for your feature.
|
||
|
|
3. Add a test (or multiple tests) for your feature.
|
||
|
|
4. Add your new feature.
|
||
|
|
5. Push to your fork and submit the pull request.
|
||
|
|
|
||
|
|
To submit a **bug fix**:
|
||
|
|
|
||
|
|
1. Create a new branch off of the `master` branch.
|
||
|
|
2. Add a test that demonstrates the bug.
|
||
|
|
3. Make the test pass.
|
||
|
|
4. Push to your fork and submit the pull request!
|
||
|
|
|
||
|
|
To submit a **documentation fix**:
|
||
|
|
|
||
|
|
1. Create a new branch off of the `master` branch.
|
||
|
|
2. Add your documentation fixes (no tests required).
|
||
|
|
3. Push to your fork and submit the pull request!
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|