Contributing to ci-multiplatform
First off, thanks for taking the time to contribute! ❤️
All types of contributions are encouraged and valued. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
And if you like the project, but just don’t have time to contribute, that’s fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
Star the project.
Refer this project in your project’s README. Consider adding a badge with:
[](https://gitlab.com/riseproject/CI/ci-multiplatform)Mention the project at local meetups and tell your friends/colleagues.
I Have a Question
If you want to ask a question, we assume that you have read the available Documentation.
Before you ask a question, it is best to search for existing issues in the main repo or in one of the mirrors (Freedesktop.org) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
If you then still feel the need to ask a question and need clarification, we recommend the following:
Open an issue. If you encounter any issues specific to a GitLab instance, please report it to the appropriate mirror.
Provide as much context as you can about what you’re running into.
We will then take care of the issue as soon as possible.
I Want To Contribute
Legal Notice
When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
Reporting Bugs
Before Submitting a Bug Report
A good bug report shouldn’t leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
Make sure that you are using the latest version.
Determine if your bug is really a bug and not an error on your side, e.g., using incompatible environment components/versions (Make sure that you have read the documentation. If you are looking for support, you might want to check this section).
To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in one of the bug trackers:
Also make sure to search the internet to see if others have discussed the issue.
Collect information about the bug:
If issue is about one of the templates, prepare a link (if public) to the failing CI job and an excerpt from the log which shows the issue.
GitLab instance address, its version, the CI runner version, and its architecture.
Can you reliably reproduce the issue? And can you also reproduce it with older revision?
Attribution
This guide is based on the contributing.md!