Skip to content

Latest commit

 

History

History
21 lines (16 loc) · 2.15 KB

Contribution.md

File metadata and controls

21 lines (16 loc) · 2.15 KB
Raw

This file contains the guidelines for contributing to the SoundScape project.

Code of conduct

Please be respectful and courteous to other contributors and users of the project. Do not use abusive, offensive, or discriminatory language. Do not harass, troll, or spam anyone. Do not post any personal or sensitive information. Violation of these rules may result in banning from the project.

Reporting issues

If you encounter any bugs, errors, or unexpected behaviors while using the project, please report them as issues on GitHub. Before creating a new issue, please check if there is already an existing issue that addresses the same problem. If not, create a new issue with a clear and descriptive title, a detailed description of the problem, the steps to reproduce it, and any relevant screenshots or error messages.

Suggesting enhancements

If you have any ideas or suggestions for improving the project, such as adding new features, improving the performance, or enhancing the user experience, please share them as issues on GitHub. Before creating a new issue, please check if there is already an existing issue that discusses the same idea. If not, create a new issue with a clear and descriptive title, a detailed explanation of your idea or suggestion, and any relevant examples or mockups.

Submitting pull requests

If you want to contribute to the project by fixing bugs, implementing features, or improving the documentation, you are welcome to submit pull requests on GitHub. Before creating a pull request, please follow these steps:

  • Fork the repository and create a new branch for your changes.
  • Make sure your code follows the PEP 8 style guide and is well-commented and documented.
  • Make sure your code is tested and does not introduce any new errors or warnings.
  • Make sure your code does not conflict with the existing code base and can be merged smoothly.
  • Write a clear and concise commit message that describes what you have done and why.
  • Write a clear and concise pull request title and description that summarizes your changes and references any related issues.
  • Wait for the project maintainers to review your pull request and provide feedback or approval.