Skip to content

Latest commit

 

History

History
23 lines (16 loc) · 1.06 KB

CONTRIBUTING.md

File metadata and controls

23 lines (16 loc) · 1.06 KB

Contributing

Thank you for wanting to contribute! Here is information on making pull requests, reporting bugs, and licensing.

Note that this repository is an experimental prototype that is still actively undergoing updates and restructruring

Proposing changes

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 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 by running npm run validate.
  5. Issue that pull request!

Reporting bugs

We use GitHub issues to track public bugs. Report a bug by opening a new issue. It's that easy!

Lincensing

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 https://gist.github.com/briandk/3d2e8b3ec8daf5a27a62.