Skip to main content

Contributing to ygégé

Complete Developer Documentation

For detailed development information, check out the developer documentation in the GitHub repository:

Thank you for your interest in contributing to the ygégé project! This page outlines ways you can help, our contribution policies, and how to get started with your first Issue or Pull Request (PR).

Even if you can't contribute code, you can still help ygégé! The main ways you can contribute are by testing, reporting issues, and improving documentation. Code, documentation, and other contributions are all welcome—see the sections below for details.

Reporting Issues​

We use GitHub Issues to track bugs, enhancements, and feature requests.

Developing Code​

ygégé is written in Rust. If you have experience with Rust, we welcome your contributions!

  • See our development guide for how to set up your development environment, build ygégé from source, and submit PRs.
  • We follow a "fork and PR" workflow. If you're new to this, see the GitHub forking guide.

Improve Documentation​

Documentation is extremely valuable! User documentation is available on this Docusaurus site, and developer documentation is in the docs/ folder of the repository.

  • To suggest changes, open a Pull Request with your improvements.
  • For major documentation changes, please open an issue or discussion first.

Testing​

Testing is one of the easiest and most valuable ways to contribute.

  • Simply use ygégé, and if you find any bugs or unexpected behavior, open an issue.
  • If you have suggestions for improvements or new features, you can also submit them as issues.

Building and Running ygégé​

Thank you for helping improve ygégé! Every contribution—big or small—makes a difference.