The following is a set of guidelines for contributing to this asset. The guidelines written here need to be followed for your contribution to be accepted with ease.
If you've found an issue with the asset, please do report it through one of the following channels. If you have a GitHub account its recommend to report an issue. But other methods are available if you don't:
- GitHub issue, using the bug template. Please check the issue you are reporting is not already listed and follow the template provided to report the issue. (https://github.com/CarterGames/AudioManager/issues).
- Bug report form (https://carter.games/report/).
- Email (hello@carter.games)
If you have ideas for new features. Do feel free to let me know.
- GitHub issue, using the feature template. (https://github.com/CarterGames/AudioManager/issues).
- Email (hello@carter.games)
This is the more compilcated contribution as you need to follow bigger guides and understanding how the asset functions behind the scenes. While I'm open to code changes, they may take longer to be accepted.
To make a code change you MUST follow the following guidelines:
- Follow the Carter Games specific Unity C# style guide for your code. Which can be found here: https://carter.games/unity-c-style-guide/
- Follow the Carter Games commit message guide for your commits which can be found here: https://carter.games/commit-emoji-guide/
- Honour the Carter Games commitment to no AI usage. Any AI generated code will be rejected regardless of how useful it may be to the project. If you've used AI for other projects you may find your contributions denied even if you didn't use AI for your contribution. See the Carter Games stance on AI here: https://carter.games/ai-policy/
- Provide documentation on your new changes or notes on what needs updating in the documentation to support your changes.
To make changes, please do the following:
- Fork the repository.
- Make your changes in your fork.
- Create a PR merging your changes into the contribution branch (https://github.com/CarterGames/AudioManager/tree/contribution). Your PR should explain what it adds to the project.
- Your code will be reviewed and if all good will be merged into the contribution branch.
- Your contribution will be merged into a future release when deemed necessary by Carter Games members. Theres a lot to a release to make it happen, so it isn't as simple as just merging to main xD