Skip to content

Latest commit

 

History

History
executable file
·
68 lines (52 loc) · 2.46 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
68 lines (52 loc) · 2.46 KB
Raw

Contributing

Table of Contents

How to Contribute

We want to make contributing to SuperSonic as easy and transparent as possible. The most helpful ways to contribute are:

  1. Provide feedback.
    • Report bugs. In particular, it’s important to report any crash or correctness bug. We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.
    • Report issues when the documentation is incomplete or unclear, or an error message could be improved.
    • Make feature requests. Let us know if you have a use case that is not well supported, including as much detail as possible.
  2. Contribute to the SuperSonic ecosystem.

Pull Requests

We actively welcome your pull requests.

  1. Fork the repo and create your branch from development.
  2. Follow the instructions for building from source to set up your environment.
  3. If you've added code that should be tested, add tests.
  4. If you've changed APIs, update the documentation.
  5. Ensure the make test suite passes.
  6. Make sure your code lints (see Code Style below).
  7. If you haven't already, complete the Contributor License Agreement ("CLA").

Code Style

We want to ease the burden of code formatting using tools. Our code style is simple:

We use pre-commit to ensure that code is formatted prior to committing. Before submitting pull requests, please run pre-commit. See the config file for installation and usage instructions.

Other common sense rules we encourage are:

  • Prefer descriptive names over short ones.
  • Split complex code into small units.
  • When writing new features, add tests.
  • Make tests deterministic.
  • Prefer easy-to-use code over easy-to-read, and easy-to-read code over easy-to-write.