Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
107 lines (74 loc) · 2.45 KB

CONTRIBUTING.md

File metadata and controls

107 lines (74 loc) · 2.45 KB

Contributing to NurOS Hello

Thank you for your interest in contributing to NurOS Hello! This document provides guidelines for contributing to the project.

Getting Started

Prerequisites

  • GTK 4.10+
  • libadwaita 1.4+
  • Meson build system
  • Blueprint compiler

Building from Source

meson setup build
meson compile -C build
./build/src/nuros-hello

How to Contribute

Reporting Bugs

Before submitting a bug report:

  1. Check existing issues at https://github.com/NurOS-Linux/hello/issues
  2. Make sure you're using the latest version

When reporting a bug, include:

  • NurOS/distribution version
  • GTK and libadwaita versions
  • Steps to reproduce the issue
  • Expected vs actual behavior
  • Screenshots if applicable

Suggesting Features

Feature requests are welcome! Please:

  1. Check if the feature has already been requested
  2. Describe the feature and its use case
  3. Explain why it would be useful for NurOS users

Code Contributions

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/your-feature)
  3. Make your changes
  4. Test your changes
  5. Commit with clear messages
  6. Push to your fork
  7. Open a Pull Request

Translation

We welcome translations! To add a new language:

  1. Copy po/nuros-hello.pot to po/LANG.po (e.g., po/de.po)
  2. Add your language code to po/LINGUAS
  3. Translate the strings in your .po file
  4. Submit a Pull Request

Current languages: English, Russian, Kazakh

Code Style

  • Follow existing code style in the project
  • Use meaningful variable and function names
  • Keep functions focused and small
  • Comment complex logic

C Code

  • Use GNU C11 standard
  • Follow GTK/GLib naming conventions
  • Use g_autoptr for automatic memory management

Blueprint UI

  • Use consistent indentation (2 spaces)
  • Group related widgets together
  • Use translatable strings with _("...")

Commit Messages

  • Use present tense ("Add feature" not "Added feature")
  • Keep the first line under 50 characters
  • Reference issues when applicable (Fixes #123)

Testing

Before submitting:

  1. Build the project successfully
  2. Run the application and test your changes
  3. Test with different languages if applicable
  4. Verify the app works with both light and dark themes

License

By contributing, you agree that your contributions will be licensed under GPL-3.0-or-later.

Questions?

Thank you for contributing!