CONTRIBUTING.md

🤝 Contributing to Food Expiration Dates

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

How to contribute

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 main.
2. Make your changes.
3. Test your changes.
4. Open a pull request with the main branch of this repo as target. Explain your changes in the description of the pull request.

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project.

As this is a free open-source project, and anyone who contributes will be mentioned among all other contributors, no payment will be provided for any contribution.

Report bugs

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 of a bug report. Here's another example from Craig Hockenberry.

Great Bug Reports tend to have:

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

License

By contributing, you agree that your contributions will be licensed under MIT License.

References

This document was adapted from this.