Contributor’s Guide

Contributor’s Guide#

Thank you for considering contributing to ggml-ot. There are many ways to contribute, from bug fixes to tutorials to API improvements.

How to Start Contributing#

  1. Start with an issue in the GitHub issue tracker.

  2. Use issues for all contribution types: bug reports, feature requests, suggestions, and documentation improvements.

  3. Check if a related issue already exists; if yes, continue there, otherwise open a new one.

  4. Once scope is clear, implement the change and open a PR linked to the issue.

What to Contribute#

We welcome contributions in these areas:

  • Code

    • Implement new features from issues.

    • Report and fix bugs.

    • Improve performance and maintainability.

  • Documentation

    • Improve docstrings and API docs.

    • Add or refine tutorials and examples.

    • Propose and contribute integration tutorials with other Python packages (especially scverse tools).

  • Tests

    • Add tests for public behavior.

    • Improve failure-case and warning coverage.

  • Ideas

    • Propose features and design improvements.

    • Suggest new package integrations and cross-tool workflows.

Contributor Topics#

Use these subpages as the canonical contributor documentation.