Contributing

Spread the word

You can also support Quollix by helping more people learn about the project:

• talk with potentially interested friends, colleagues, or organizations
• share it on social media
• write blogs or reviews where they are useful
• suggest other practical ways to reach people who may benefit from Quollix

Provide feedback

You can provide feedback through the feedback page, or through GitHub issues or discussions.

Contribute on GitHub

Quollix repositories use the permissive MIT License. Contributions are made under the license of the repository being contributed to. Quollix does not require contributors to sign a Contributor License Agreement (CLA).

To get an overview of the public source code repositories, see the Repository Map.

Improve the website

The website repository is github.com/quollix/website. Contributing website content does not require coding: basic Markdown knowledge and knowing how to contribute through GitHub are sufficient. Read the Website contributing article.

Contribute code

To contribute code, fork the repository, create a new branch, make your changes, and submit a pull request (PR). Branches should use the form <issueNumber>-<title>. If no issue exists yet for the problem, please create one first.

If you are fixing a bug, include the steps to reproduce it, the expected result, and the actual result. Include screenshots or logs if useful. See the Developer Guide for code contribution expectations.

Small fixes can be provided directly as PRs. Before creating a feature PR, open a feature suggestion issue and get Quollix maintainer approval first, because features must fit the design of Quollix.

Build integrations

Quollix includes a Go API client in the common repository at quollix/api_client. It is used by Quollix tooling and can also be useful for experiments, automation, or external tools built around Quollix.

Expand the App Store

If you have software with a web interface that you would like to share with others, you can package it as an app and request an App maintainer account. See Join the App Store. If an app becomes popular, we will consider adopting it as an official app.

Improve app compatibility

You can also help by improving the upstream software used by apps in the App Store. When those improvements are released, packaged as Docker images, and integrated into Quollix app updates, they become available to Quollix deployments.

High-value improvements include:

• OIDC authorization code flow support for confidential clients
• automatic OIDC client configuration through Docker environment variables

See App Design Recommendations for details.

Improve security

Security-related contributions are useful. Please follow Responsible Disclosure when researching and reporting vulnerabilities.