-
Notifications
You must be signed in to change notification settings - Fork 64
📝 added contributing md #203
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
oguzkaganeren
wants to merge
3
commits into
CachyOS:develop
Choose a base branch
from
oguzkaganeren:feat/CONTRIBUTINGMD
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| # Contributing to CachyOS Welcome | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - Rust (stable, via `rustup`) | ||
| - 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 | ||
| cargo build | ||
| ``` | ||
|
|
||
| For a release build: | ||
|
|
||
| ```sh | ||
| cargo build --release | ||
| ``` | ||
|
|
||
| ## 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/<locale>/` | ||
| 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 | ||
|
|
||
| ## Debugging | ||
|
|
||
| Run with verbose output using the `RUST_LOG` environment variable: | ||
|
|
||
| ```sh | ||
| RUST_LOG=debug cargo run | ||
| ``` | ||
|
|
||
| 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 cargo run | ||
| ``` | ||
|
|
||
| To suppress noisy crates: | ||
|
|
||
| ```sh | ||
| RUST_LOG=debug,i2n_embed=warn,which=warn cargo run | ||
| ``` | ||
|
|
||
| ## Reporting Issues | ||
|
|
||
| Use the [GitHub issue tracker](https://github.com/cachyos/cachyos-welcome/issues). Include your CachyOS version and steps to reproduce. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should show pacman command to install all dependencies
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
added install command