Skip to content

Contributing to Sonaric

Thank you for your interest in contributing to Sonaric! We welcome contributions from the community in various forms, including bug reports, feature requests, code contributions, and documentation improvements.

Reporting Issues

If you encounter a bug or have a feature request, please submit an issue on our GitHub choosing the appropriate repository. When submitting an issue, please provide as much detail as possible, including:

  • Steps to reproduce the bug
  • Expected behavior and actual behavior
  • Screenshots or error messages, if applicable
  • Sonaric version and operating system

Our team will review your issue and respond as soon as possible.

Alternatively, you can report issues in the Sonaric Discord server.

Reporting Vulnerabilities

If you discover a security vulnerability in Sonaric, please report it to us immediately by emailing marcin@sonaric.xyz. We take security vulnerabilities seriously and will work with you to address the issue promptly.

Kit Contributions

To contribute kits to Sonaric, please follow these steps:

  1. Fork the Sonaric repository on GitHub.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and commit them with descriptive commit messages.
  4. Push your changes to your forked repository.
  5. Submit a pull request to the main Sonaric repository.

Before submitting a pull request, please ensure that your code follows the Sonaric coding conventions, passes all tests, and includes appropriate documentation.

Documentation Improvements

Improvements to the Sonaric documentation are always welcome. If you find any errors, typos, or unclear explanations, please submit a pull request with your proposed changes to Sonaric Docs repository.

Community Content

We encourage community members to create and share content related to Sonaric, such as tutorials, blog posts, videos, or artwork. If you have created something that you'd like to share with the community, please let us know in the Discord server or on Twitter.

Code of Conduct

By participating in the Sonaric community, you agree to abide by our Code of Conduct. Please be respectful, inclusive, and considerate in all your interactions with the community.

Thank you for your contributions and for being a part of the Sonaric community!