Skip to content

Latest commit

 

History

History
26 lines (21 loc) · 1.15 KB

CONTRIBUTING.md

File metadata and controls

26 lines (21 loc) · 1.15 KB
Raw

Contributing

I'd love your input! I want to make contributing to this project as easy and transparent as possible.

Open an issue for:

  • Requesting new content
  • Requesting new features
  • Reporting anything incorrect
  • Reporting a bug
  • Discussing the current state of the code
  • etc

Code Change Proposals

All code change proposals happen through pull requests, as per Github Flow, so...

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

License

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

References

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