Open source and contributing

Get help, report a problem or contribute a change. CapacityLens is open source under the GNU Affero General Public License v3.0. Read the source code and the full licence. You may run a modified version for your company under its terms, including those for providing the software over a network.

Philosophy explains what CapacityLens leaves out, How it is tested the automated checks, and How it compares where other tools fit better.

Get help

For a usage or operating question, when nothing appears broken, follow the support guide. Include the release version, the guide page, what you were trying to do, what happened and any non-sensitive error message.

Report a problem or suggest an improvement

Search existing GitHub issues, then open one describing a single problem with the smallest example that reproduces it. Remove credentials, invitation links, real customer data and other private information.

For documentation, name the page, quote the confusing instruction and say what you were trying to do. You don't need to be a developer: clear bug reports and documentation corrections help.

Contribute a change

Read the contribution guide first. It covers setup, standards, tests, signed commits and the pull-request process.

For documentation, edit the Markdown sources under docs-src/, follow the documentation style guide, and rebuild the committed site before opening a pull request.

Report a vulnerability

Never publish a vulnerability or credential in a public issue. Follow the private reporting instructions in the security policy.