Contributing to Sound Bakery

Thank you for your interest in contributing to Sound Bakery. With your help, we can make something excellent.

Table of Contents

• How to Contribute
• Reporting Issues
• Suggesting UI/UX
• Submitting Pull Requests
• Code Style
• Testing
• Documentation
• Community

How to Contribute

There are several ways to contribute:

• Reporting bugs and issues
• Suggesting new features and enhancements
• Suggesting visual improvements
• Submitting pull requests to fix bugs or add features
• Submitting pull requests to improve code cleanliness and technical debt
• Improving documentation

Reporting Issues

If any bugs or issues are encountered, please report them using the GitHub issue tracker. When reporting an issue, please provide as much detail as possible, including:

• A clear and descriptive title
• Steps to reproduce the issue
• Expected and actual results
• Any relevant screenshots or logs
• The version of Sound Bakery and your development environment

Suggesting UI UX

How to contribute visual improvements is an open question. Please reach out with designs and ideas on the issue tracker or discussions. If you have ideas for collaborating on the UI of Sound Bakery, please speak up.

Submitting Pull Requests

To submit a pull request (PR), follow these steps:

1. Fork the Repository: Fork the Sound Bakery repository to your GitHub account.
2. Clone Your Fork: Clone your forked repository to your local machine.

   git clone https://github.com/KarateKidzz/sound-bakery.git
   cd sound-bakery

3. Create a Branch: Create a new branch for your feature or bugfix.

   git checkout -b feature-or-bugfix-name

4. Make Changes: Make your changes to the codebase. Ensure that your changes follow the project's code style and include tests if applicable.
5. Commit Changes: Commit your changes with a clear and descriptive commit message.

   git commit -m "Description of the changes made"

6. Push Changes: Push your changes to your forked repository.

   git push origin feature-or-bugfix-name

7. Create a Pull Request: Create a pull request to the main repository. Provide a detailed description of your changes and any relevant information.

Code Style

Sound Bakery integrates clang-format and clang-tidy to ensure code quality and consistency. Please follow these guidelines when contributing:

• Use modern C++20 features and standard library components.
• Write for people first and the machine second.
• Ensure that your code is properly formatted using clang-format.
• Run clang-tidy to catch and fix potential issues.

Code style is a collaborative effort and discussions around style are welcome.

Testing

‍Testing is WIP and details will be added in the future.

Documentation

Sound Bakery uses Doxygen for documentation generation. Therefore, documentation is mainly written in the code and guides written in markdown. Please ensure documentation is present for public API functions. Otherwise, write comments for classes and functions where appropriate.

Using Doxygen

To generate documentation using Doxygen, follow these steps:

1. Install Doxygen.
2. Add Doxygen-style comments to your code. Here is an example:

    
   void init();

3. Build the Doxygen Documentation:
   • Ensure that CMake is set up for the project.
   • Build the doc_doxygen target:

     cd build
     cmake --build . --target doc_doxygen

Generated documentation will be available in the doxygen directory.

Community

Sound Bakery aims to foster a welcoming and inclusive community. When contributing, please:

• Be respectful and considerate of others.
• Provide constructive feedback and support.
• Follow the Code of Conduct to ensure a positive environment for all contributors.

---

Thank you for contributing! If you have any questions, feel free to reach out via the issue tracker or discussions.