Skip to content

Latest commit

 

History

History
57 lines (36 loc) · 2.06 KB

CONTRIBUTING.md

File metadata and controls

57 lines (36 loc) · 2.06 KB
Raw

Contribution Guide

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

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, So 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 master.
  2. Write tests for the code added, if required.
  3. Update the documentation.
  4. Ensure the tests pass.
  5. Make sure your code lints.
  6. Issue that 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. 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

Great Bug Reports tend to have:

  • A quick summary and background
  • Steps to reproduce
    • Be as specific as possible.
    • Providing sample code is highly encouraged.
  • What you expected would happen.
  • What actually happened.
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

People love thorough bug reports.

Use a Consistent Coding Style

Make sure the code is lint-ed based on the pedantic analysis configuration.

License

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

References

This document was adapted from the open-source contribution guidelines for Facebook's Draft