Contributing¶

This part of the byro documentation is for you if you want to improve byro, work on the documentation or contribute to a release.

If you want to improve byro itself, please head to our contributor documentation.

If you want to work on byro's code (no matter which part), you'll want to start with the development setup. It contains the contributing guidelines, an explanation on how to build a pull request, which style guidelines to follow, and an internal API documentation.

The REST API has its own section. Plugin development guides and the signal list are under Plugins, in Plugin development.

If you maintain byro and prepare a release, Releasing byro describes the release pipeline, the stable pointer for byroctl and the release flags.

If any part of the documentation is unclear, please head over to Working on the documentation to learn how to improve it, and then follow the contributor documentation to create a pull request.