Skip to content

Latest commit

 

History

History
58 lines (42 loc) · 4.4 KB

Contribution.md

File metadata and controls

58 lines (42 loc) · 4.4 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.

Alternatively contribute using GitHub Desktop

  1. Open GitHub Desktop: Launch GitHub Desktop and log in to your GitHub account if you haven't already.

  2. Clone the Repository:

    • If you haven't cloned the SoundScape repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."
    • Choose the SoundScape repository from the list of repositories on GitHub and clone it to your local machine.

  3. Switch to the Correct Branch:

    • Ensure you are on the branch that you want to submit a pull request for.
    • If you need to switch branches, you can do so by clicking on the "Current Branch" dropdown menu and selecting the desired branch.

  4. Make Changes: Make your changes to the code or files in the repository using your preferred code editor.

  5. Commit Changes:

    • In GitHub Desktop, you'll see a list of the files you've changed. Check the box next to each file you want to include in the commit.
    • Enter a summary and description for your changes in the "Summary" and "Description" fields, respectively. Click the "Commit to " button to commit your changes to the local branch.

  6. Push Changes to GitHub: After committing your changes, click the "Push origin" button in the top right corner of GitHub Desktop to push your changes to your forked repository on GitHub.

  7. Create a Pull Request:

  • Go to the GitHub website and navigate to your fork of the SoundScape repository.
  • You should see a button to "Compare & pull request" between your fork and the original repository. Click on it.

  1. Review and Submit:

    • On the pull request page, review your changes and add any additional information, such as a title and description, that you want to include with your pull request.
    • Once you're satisfied, click the "Create pull request" button to submit your pull request.

  2. Wait for Review: Your pull request will now be available for review by the project maintainers. They may provide feedback or ask for changes before merging your pull request into the main branch of the SoundScape repository.

⭐️ Support the Project If you find this project helpful, please consider giving it a star on GitHub! Your support helps to grow the project and reach more contributors.