32 lines
2.3 KiB
Markdown
32 lines
2.3 KiB
Markdown
# Garuda Linux common settings
|
|
|
|
[](http://commitizen.github.io/cz-cli/)
|
|
|
|
## Found any issue?
|
|
|
|
- If any packaging issues occur, don't hesitate to report them via our issues section of our PKGBUILD repo. You can click [here](https://gitlab.com/garuda-linux/pkgbuilds/-/issues/new) to create a new one.
|
|
- If issues concerning the configurations and settings occur, please open a new issue on this repository. Click [here](https://gitlab.com/garuda-linux/themes-and-settings/settings/garuda-common-settings/-/issues/new) to start the process.
|
|
|
|
## How to contribute?
|
|
|
|
We highly appreciate contributions of any sort! 😊 To do so, please follow these steps:
|
|
|
|
- [Create a fork of this repository](https://gitlab.com/garuda-linux/themes-and-settings/settings/garuda-common-settings/-/forks/new).
|
|
- Clone your fork locally ([short git tutorial](https://rogerdudler.github.io/git-guide/)).
|
|
- Add the desired changes to PKGBUILDs or source code.
|
|
- Commit using a [conventional commit message](https://www.conventionalcommits.org/en/v1.0.0/#summary) and push any changes back to your fork. This is crucial as it allows our CI to generate changelogs easily.
|
|
- The [commitizen](https://github.com/commitizen-tools/commitizen) application helps with creating a fitting commit message.
|
|
- You can install it via [pip](https://pip.pypa.io/) as there is currently no package in Arch repos: `pip install --user -U Commitizen`.
|
|
- Then proceed by running `cz commit` in the cloned folder.
|
|
- [Create a new merge request at our main repository](https://gitlab.com/garuda-linux/themes-and-settings/settings/garuda-common-settings/-/merge_requests/new).
|
|
- Check if any of the pipeline runs fail and apply eventual suggestions.
|
|
|
|
We will then review the changes and eventually merge them.
|
|
|
|
## Where is the PKGBUILD?
|
|
|
|
The PKGBUILD can be found in our [PKGBUILDs](https://gitlab.com/garuda-linux/pkgbuilds) repository. Accordingly, packaging changes need to be happening over there.
|
|
|
|
## How to deploy a new version?
|
|
|
|
To deploy a new version, pushing a new tag is sufficient. The deployment will happen automatically via the [PKGBUILDs repo's pipelines](https://gitlab.com/garuda-linux/pkgbuilds/-/pipelines), which check half-hourly for the existance of a more recent tag.
|