From 9ecdcc7fab95b811bb00e4f5202632f8ad1f3b4b Mon Sep 17 00:00:00 2001 From: Oguz Kagan EREN Date: Sat, 28 Mar 2026 11:38:19 +0300 Subject: [PATCH 1/3] =?UTF-8?q?=F0=9F=93=9D=20added=20contributing=20md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9aac9db --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,53 @@ +# Contributing to CachyOS Welcome + +## Prerequisites + +- Rust (stable, via `rustup`) +- `meson` and `ninja` +- GTK 3.24.33+ +- `glib-2.0` and `gio-2.0` 2.66+ + +## Building + +```sh +meson setup build +ninja -C build +``` + +For a release build: + +```sh +meson setup build --buildtype=release +ninja -C build +``` + +## Code Style + +The project uses `rustfmt`. Before submitting, run: + +```sh +cargo fmt +``` + +Configuration is in [rustfmt.toml](rustfmt.toml). + +## Translations + +Translations use [Fluent](https://projectfluent.org/) and live in [i18n/](i18n/). Each locale has its own directory (e.g., `i18n/de/`). + +To add a new language: + +1. Copy `i18n/en/` to `i18n//` +2. Translate the `.ftl` files +3. Add the locale to [i18n.toml](i18n.toml) + +## Submitting Changes + +1. Fork the repository and create a feature branch +2. Make your changes and ensure the build passes +3. Run `cargo fmt` and `cargo clippy` +4. Open a pull request with a clear description of the change + +## Reporting Issues + +Use the [GitHub issue tracker](https://github.com/cachyos/cachyos-welcome/issues). Include your CachyOS version and steps to reproduce. From db8796317aaa3747323084ec95326b061f816b6a Mon Sep 17 00:00:00 2001 From: Oguz Kagan EREN Date: Sat, 28 Mar 2026 11:47:29 +0300 Subject: [PATCH 2/3] =?UTF-8?q?=F0=9F=93=9D=20add=20debugging=20section?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9aac9db..fe92091 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -48,6 +48,28 @@ To add a new language: 3. Run `cargo fmt` and `cargo clippy` 4. Open a pull request with a clear description of the change +## Debugging + +Run with verbose output using the `RUST_LOG` environment variable: + +```sh +RUST_LOG=debug ninja -C build && ./build/src/cachyos-hello +``` + +Logs are written to both stdout and `~/.config/cachyos/cachyos-hello/cachyos-hello.log`. + +To filter log output to a specific module: + +```sh +RUST_LOG=cachyos_hello=debug ./build/src/cachyos-hello +``` + +To suppress noisy crates: + +```sh +RUST_LOG=debug,i2n_embed=warn,which=warn ./build/src/cachyos-hello +``` + ## Reporting Issues Use the [GitHub issue tracker](https://github.com/cachyos/cachyos-welcome/issues). Include your CachyOS version and steps to reproduce. From e147615ea8e5e7545c89222ae4a2e0a9eb6bd994 Mon Sep 17 00:00:00 2001 From: Oguz Kagan EREN Date: Sat, 28 Mar 2026 22:32:33 +0300 Subject: [PATCH 3/3] =?UTF-8?q?=F0=9F=93=9D=20updated=20contributing?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fe92091..03eeb54 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,22 +3,26 @@ ## Prerequisites - Rust (stable, via `rustup`) -- `meson` and `ninja` - GTK 3.24.33+ - `glib-2.0` and `gio-2.0` 2.66+ +Install all dependencies on CachyOS/Arch: + +```sh +sudo pacman -S --needed rustup gtk3 glib2 +rustup toolchain install stable +``` + ## Building ```sh -meson setup build -ninja -C build +cargo build ``` For a release build: ```sh -meson setup build --buildtype=release -ninja -C build +cargo build --release ``` ## Code Style @@ -53,7 +57,7 @@ To add a new language: Run with verbose output using the `RUST_LOG` environment variable: ```sh -RUST_LOG=debug ninja -C build && ./build/src/cachyos-hello +RUST_LOG=debug cargo run ``` Logs are written to both stdout and `~/.config/cachyos/cachyos-hello/cachyos-hello.log`. @@ -61,13 +65,13 @@ Logs are written to both stdout and `~/.config/cachyos/cachyos-hello/cachyos-hel To filter log output to a specific module: ```sh -RUST_LOG=cachyos_hello=debug ./build/src/cachyos-hello +RUST_LOG=cachyos_hello=debug cargo run ``` To suppress noisy crates: ```sh -RUST_LOG=debug,i2n_embed=warn,which=warn ./build/src/cachyos-hello +RUST_LOG=debug,i2n_embed=warn,which=warn cargo run ``` ## Reporting Issues