Every feedback is welcome!
Do not hesitate to:
- Report bugs
- Open discussions around the current state of the code
- Request new features
- Submit fixes/improvments
everything happen through Github, use Issues/Pull requests features.
See the Github Flow.
The best way to have a pull requested accepted is to:
- Fork the repo and create your branch from
master - If you've added code that should be tested, add tests
- If you've changed APIs, update the documentation
- Ensure the test suite passes
- Make sure your code lints ---------------------------------
- Issue that pull request!
In short, when you submit code changes, your submissions are understood to be under the same ISC License that covers the project. eel free to contact the maintainers if that's a concern.
We use GitHub issues to track public bugs. Report a bug by opening a new issue it's that easy!
This is an example of a bug report I wrote, and I think it's not a bad model. Here's another example from Craig Hockenberry, an app developer whom I greatly respect.
Great Bug Reports tend to have:
- A quick summary and/or background
- Steps to reproduce
- Be specific!
- Give sample code if you can. My stackoverflow question includes sample code that anyone with a base R setup can run to reproduce what I was seeing
- What you expected would happen
- What actually happens
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
People love thorough bug reports. I'm not even kidding.
Try to mimic the codebase style and run ormolu on each commit.
By contributing, you agree that your contributions will be licensed under its ISC License.