Skip to content

Latest commit

 

History

History
22 lines (12 loc) · 948 Bytes

File metadata and controls

22 lines (12 loc) · 948 Bytes

Contributing

Gearberg is in early development. The architecture and APIs are still evolving, so we are not accepting general pull requests at this time.

What we do accept

  • Bug reports — open an issue with steps to reproduce, expected behavior, and actual behavior
  • Feature requests — open an issue describing the use case

If you want to contribute code

Reach out first by opening an issue to discuss your idea. Once the project stabilizes, we will open up broader contributions.

Development setup

Firstly, install the Nix package manager, clone the repo, and change directory. Secondly, see the Makefile for available commands. Run make verify before submitting anything: all checks must pass.

Note: Please reach out to the maintainers before adding any code.

License

By contributing you agree that your contributions will be licensed under the AGPL-3.0.