CONTRIBUTING.md

Contributing to NERD

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

• Reporting a bug
• Discussing the current state of the code
• Submitting a fix
• Proposing new features
• Becoming a maintainer

We Develop with Github

We use github to host code, to track issues and feature requests, as well as accept pull requests.

We Use Github Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:

1. Fork the repo and create your branch from develop.
2. Make sure your changes comply with the following checklist:
   • Comments: Are the comments clear and useful?
   • Complexity: Could the code be made simpler? Would another developer be able to easily understand and use this code when they come across it in the future?
   • Design: Is the code well-designed and appropriate for your system?
   • Documentation: Did the developer also update relevant documentation?
   • Functionality: Does the code behave as the author likely intended? Is the way the code behaves good for its users?
   • Interface: Any interface changes are sensible and look good.
   • Naming: Did the developer choose clear names for variables, classes, methods, etc.?
   • Style: Does the code follow our style guides?
   • Tests: Does the code have correct and well-designed automated tests?
   • YAGNI: The developer is not implementing things they might need in the future but don’t know they need now.
3. Create that pull request!

Any contributions you make will be under the AGPL-3.0 Software License

In short, when you submit code changes, your submissions are understood to be under the same AGPL-3.0 License that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Write bug reports with detail, background, and sample code

This is an example from Craig Hockenberry of a bug report.

Great Bug Reports tend to have:

• A quick summary and/or background
• Steps to reproduce
  • Be specific!
  • Give sample code if you can. Briandk 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)

License

By contributing, you agree that your contributions will be licensed under its AGPL-3.0 License.

References

This document was adapted from briandk's template.