Skip to content

Latest commit

 

History

History
44 lines (34 loc) · 1.83 KB

File metadata and controls

44 lines (34 loc) · 1.83 KB

Contributing to hyprKCS

First off, thank you for considering contributing to hyprKCS! It's people like you that make hyprKCS such a great tool.

Ways to Contribute

  • Reporting Bugs: If you find a bug, please open an issue. Include details about your environment (Hyprland version, distro) and steps to reproduce.
  • Suggesting Features: Have an idea? open an issue to discuss it.
  • Code Contributions: Fix bugs, add features, or improve documentation via Pull Requests.

Manual Setup

Ensure you have the following installed on your system:

  • rustc / cargo
  • gtk4
  • libadwaita
  • pkg-config

Contribution Workflow

  1. Fork the repository and clone it locally.
  2. Create a branch for your changes:
    git checkout -b feature/my-new-feature
  3. Implement your changes. Ensure your code follows the existing style and architectural patterns (GTK4/Libadwaita with Rust).
  4. Verify your changes:
    • Build: cargo build
    • Run: cargo run
    • Test: cargo test
    • Check formatting: cargo fmt --all -- --check
  5. Commit your changes. Keep commit messages clear and concise.
  6. Push to your fork and submit a Pull Request.

Coding Guidelines

  • Style: Use cargo fmt to ensure consistent formatting.
  • Error Handling: Use anyhow for application-level error handling.
  • UI: Leverage Libadwaita widgets to maintain a native look and feel.
  • Safety: Avoid unsafe blocks unless absolutely necessary for FFI.
  • Testing: Write tests for new features and bug fixes. Make sure existing tests pass.

License

By contributing to hyprKCS, you agree that your contributions will be licensed under the GPL-3.0 License.