Contributing

Process overview

Congratulations, you have made changes that you would like to get merge in the ci-tron project!

Here is a quick overview of the steps:

  • Code of conduct: Like all Freedesktop.org project, contributing to this project requires accepting the terms of the Contributor Covenant Code of Conduct.

  • Commit history: Please split your changes into atomic commits, and write good commit messages motivating the change.

  • Fork / merge request: This project uses a fork/merge-request workflow:

    1. Fork ci-tron;

    2. Push your tree/commit to a branch in your fork;

    3. Open a merge request by following the link GitLab provided during the push;

    4. Wait for the CI results, then address failures;

    5. Wait for review comments, then address them;

    6. Once the code is deemed ready by a trusted developer, it will be merged.

Frequently Asked Questions

I can’t fork ci-tron, what is going on?

Due to an influx of spam, Freedesktop.org had to impose restrictions on new accounts.

Please see this wiki page for instructions on how to get full permissions.

The automated tests fail due to runner permission issues, what do I do?

Due to serious abuse of Freedesktop’s testing infrastructure (details), the use of the GitLab CI on freedesktop.org got restricted. Only group members can trigger pipelines, everyone else needs the pipeline manually triggered by an existing group member. See Freedesktop’s wiki for more details and possible remediation.

You may however use your CI-tron-based gateway to run your tests by exposing it in your fork. This can be achieved by: