Skip to main content

Contributors' Guide

It is probably safe to assume you would like to contribute to Buz in some capacity if you are reading this. Thank you.

The success of this project depends on people like you, and it is very generous. Your contributions are welcomed and appreciated.

We will be formalizing the contribution process soon. In the meantime please refer to the following:

General Feedback

Feel free to:

Contributing Documentation

A quick guide to contributing documentation is located here.

Contributing Code

A quick guide to contributing code is located here.

Feature Requests

If you'd like to see a piece of functionality included in Buz (sink, input protocol, registry functionality, etc) please create a Github Issue.

Bug Reports

If you'd like to report a bug please create a Github Issue.

When creating a bug-related Github issue, the following information is very helpful to include:

  • A detailed description
  • Steps to reproduce
  • Screenshots/gifs of the issue
  • Stacktrace, if applicable

Other

We have an insider's signup form here if you'd like to stay in involved or in the know.

Licensing

Buz is licensed as Apache 2.0. Which means you can freely use it for just about anything.