We appreciate your interest in contributing to SLS. This page outlines how to submit bug reports, feature suggestions, and code changes.
See CONTRIBUTING.md for additional information.
The easiest way to get started is to ask for help in our Discord server.
There are several ways you can contribute to SLS:
If you run into a bug, search the issue tracker for an existing report first.
If nothing matches, open a new issue. Follow any template provided, and describe the problem clearly, including steps to reproduce when possible. Screenshots, logs, or small code snippets often make issues much easier to resolve.
If you have an idea for improving SLS, open an issue on the issue tracker. Describe the feature in enough detail for others to understand the goal: what problem it solves, how it might work, and any tradeoffs or implementation angles you have in mind.
- Fork and clone — Fork SLS on GitHub, then clone your fork locally so you can push branches to it.
- Branch — Create a branch for your work (for example
fix/…orfeature/…) instead of committing directly onmain. - Tooling — SLS is primarily Go and Java. Install a recent Go toolchain and JDK appropriate for the modules you are changing, and use the repo’s usual build or test commands before you open a PR.
- Submit — Push your branch to your fork and open a pull request against the upstream repository. Summarize what changed and why, and link related issues if any.
Pull requests are reviewed in line with the project’s CONTRIBUTING.md (including the Individual Contributor License Agreement where applicable).