Skip to content
Snippets Groups Projects
After you've reviewed these contribution guidelines, you'll be all set to contribute to this project.
CONTRIBUTING.md 7.76 KiB

Contributing to steam-runtime-tools

Issue tracking

Our main bug tracking system for the whole Steam Runtime is https://github.com/ValveSoftware/steam-runtime/issues. Before reporting an issue, please take a look at the bug reporting information to make sure your issue report contains all the information we need.

The issue tracker on our Gitlab installation, gitlab.steamos.cloud, is primarily used by steam-runtime-tools developers to track issues for which we already know the technical details of what is happening.

Contributing code

At the moment our Gitlab installation, gitlab.steamos.cloud, is not set up to receive merge requests from third-party contributors. However, git is a distributed version control system, so it is possible to push a clone of the steam-runtime-tools git repository to some other git hosting platform (such as Github or gitlab.com) and send a link to a proposed branch via an issue report.

If you want to contribute code to steam-runtime-tools, please include a Signed-off-by message in your commits to indicate acceptance of the Developer's Certificate of Origin terms.

Doing test-builds

For quick tests during development, you can build on any reasonably modern Linux distribution. Ubuntu 18.04 and Debian 10 are examples of suitable versions.

To check that everything works in the older Steam Runtime 1 'scout' environment, either use Gitlab-CI, or do a meson dist on a modern distribution and use that to build a package in the SteamRT environment. The Gitlab-CI does the meson dist in the build step, and builds the package on SteamRT in the autopkgtest step.