First off, thank you for considering contributing to loopin-ambience-mode! It's people like you that make it a great tool for everyone.
- Check the existing issues to see if the bug has already been reported.
- If not, open a new issue. Clearly describe the problem, including steps to reproduce it and your environment (OS, hardware, etc.).
- Open a new issue and describe the enhancement you'd like to see and why it would be useful.
- Fork the repository on GitHub.
- Clone your fork locally.
- Create a branch for your changes:
git checkout -b feature/your-feature-nameorbugfix/your-bug-name. - Make your changes.
- Commit your changes with clear and descriptive commit messages.
- Push your branch to your fork on GitHub.
- Submit a Pull Request to the
mainbranch of the original repository.
To keep the codebase clean and consistent, please follow these guidelines for C++:
- Standard: C++17
- Naming:
- Classes:
PascalCase - Methods and functions:
camelCase - Variables:
camelCase - Constants and Enums:
SCREAMING_SNAKE_CASE - Files:
PascalCase.cpp/PascalCase.h
- Classes:
- Indentation: Use 4 spaces (no tabs).
- Braces: Place braces on their own lines for classes and functions. For control flow (if, while, etc.), follow the style prevalent in the file.
- Documentation: Use Doxygen-style comments for public APIs.
- Headers: Use
#pragma oncefor header guards.
Before submitting a PR, ensure that the project builds successfully on your platform and that any existing tests pass.
mkdir build && cd build
cmake ..
make -j$(nproc)Thank you for your contributions!