CONTRIBUTING.md

Contributing to Our Project

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

Overview

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 (Almost) All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:

1. Fork the repo and create your branch from develop or related branch.
2. If you've added code that should be tested, add tests.
3. If you've changed APIs, update the documentation.
4. Ensure the test suite passes.
5. Make sure your code lints.
6. Issue that pull request!

References for Merging Pull Requests

For best practices, please refer to this guide.

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

Great Bug Reports tend to have:

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

Commit Messages and Pull Request Guidelines

• Follow our commit template for commit messages.
• Follow our Pull Request templates when creating a new Pull Request.
  • bug_fix_template.md
  • documentation_update_template.md
  • feature_addition_template.md

License

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

Questions?

Feel free to contact the project maintainers.

Thank you for contributing!