Contributing to ShapeKt

May 31, 2022 · View on GitHub

We welcome and greatly value all kinds of contributions to ShapeKt. You can contribute in several ways:

  • Opening issues
  • Enabling or extending plugin functionality
  • Adding new shape functions
  • Adding new examples
  • Adding documentation

TODO: Decide on contribution guidelines

Issues

If you encounter any issues, feel free to report it using GitHub issues. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.

Pull Requests

TODO: Decide on PR best practices.

  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. If you haven't already, complete the Contributor License Agreement ("CLA").

Contributor License Agreement ("CLA")

In order to accept your pull request, we need you to submit a CLA. You only need to do this once to work on any of Meta’s open source projects.

Complete your CLA here: https://code.facebook.com/cla

License

By contributing to ShapeKt, you agree that your contributions will be licensed as described in the LICENSE file in the root directory of this source tree.