CONTRIBUTING.md

Table of Contents

• Contributing
  • All Code Changes Happen Through Pull Requests
  • All contributions are under the MIT Software License
  • Report bugs using Github's issues
  • Write bug reports with detail, background, and sample code
  • License
  • References

Contributing

I'd love to have your input! All contributions are welcome including but not limited to:

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

##Github Flow, All Code Changes Happen Through Pull Requests

1. Fork the repo and create your branch from master.
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!

Any contributions you make will be under the MIT Software License

Your submissions are under the same MIT License that covers the project.

Report bugs using Github's issues

Report a bug by opening a new issue;

Write bug reports with detail, background, and sample code

This is an example of a bug report which is not a bad model.

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)

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