From 6cafff2627b832e31a5c5380e038a81c4ac76335 Mon Sep 17 00:00:00 2001 From: vorlie Date: Thu, 1 Aug 2024 20:28:55 +0200 Subject: [PATCH] Change contributing location --- CONTRIBUTING.md | 41 +++++++++++++++++++++++++++++++++++++++++ README.md | 43 ------------------------------------------- 2 files changed, 41 insertions(+), 43 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c4eee58 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,41 @@ +# Contributing + +We welcome contributions from the community! To ensure a smooth process, please follow these standard guidelines when contributing to this project: + +### Submitting Issues + +1. **Search Existing Issues**: Before submitting a new issue, please check if it has already been reported. +2. **Provide Details**: When creating an issue, include as much detail as possible. Describe the problem, steps to reproduce it, and any relevant context or screenshots. + +### Proposing Enhancements + +1. **Search Existing Proposals**: Check if the enhancement has already been suggested. +2. **Describe the Enhancement**: Clearly explain the proposed enhancement and why it would be beneficial. Include examples or use cases if possible. + +### Contributing Code + +1. **Fork the Repository**: Create a fork of the repository to work on your changes. +2. **Create a Branch**: Use a descriptive branch name that clearly states the purpose of your changes (e.g., `fix-issue-123`, `add-new-feature`). +3. **Make Changes**: Implement your changes, ensuring that your code adheres to the project's coding standards and guidelines. +4. **Write Tests**: If applicable, add tests for your changes to ensure they work correctly and do not break existing functionality. +5. **Commit Your Changes**: Write clear and concise commit messages that explain the purpose of your changes. +6. **Push to Your Fork**: Push your changes to your forked repository. +7. **Create a Pull Request**: Submit a pull request to the original repository. Provide a detailed description of your changes, including any relevant issue numbers. + +### Review Process + +1. **Code Review**: Your pull request will be reviewed by project maintainers. They may request changes or ask for additional information. +2. **Respond to Feedback**: Address any feedback or changes requested by the maintainers in a timely manner. +3. **Approval and Merge**: Once your changes have been approved, they will be merged into the main branch. + +### Coding Standards + +- **Write Clear Comments**: Use comments to explain complex or non-obvious parts of your code. +- **Update Documentation**: If your changes affect the project's documentation, update it accordingly. + +### Additional Notes + +- **Be Respectful**: Treat other contributors and maintainers with respect. We value a welcoming and inclusive community. +- **Stay Updated**: Keep your fork and branch up to date with the latest changes from the main repository. + +Thank you for contributing to our project! Your efforts help make it better for everyone. diff --git a/README.md b/README.md index 935669f..7de43bc 100644 --- a/README.md +++ b/README.md @@ -248,49 +248,6 @@ For automatic recognition, the song files in the selected folder should follow t - **Review logs:** Check `combined_app.log` for detailed logging information if issues arise. -## Contributing - -We welcome contributions from the community! To ensure a smooth process, please follow these standard guidelines when contributing to this project: - -### Submitting Issues - -1. **Search Existing Issues**: Before submitting a new issue, please check if it has already been reported. -2. **Provide Details**: When creating an issue, include as much detail as possible. Describe the problem, steps to reproduce it, and any relevant context or screenshots. - -### Proposing Enhancements - -1. **Search Existing Proposals**: Check if the enhancement has already been suggested. -2. **Describe the Enhancement**: Clearly explain the proposed enhancement and why it would be beneficial. Include examples or use cases if possible. - -### Contributing Code - -1. **Fork the Repository**: Create a fork of the repository to work on your changes. -2. **Create a Branch**: Use a descriptive branch name that clearly states the purpose of your changes (e.g., `fix-issue-123`, `add-new-feature`). -3. **Make Changes**: Implement your changes, ensuring that your code adheres to the project's coding standards and guidelines. -4. **Write Tests**: If applicable, add tests for your changes to ensure they work correctly and do not break existing functionality. -5. **Commit Your Changes**: Write clear and concise commit messages that explain the purpose of your changes. -6. **Push to Your Fork**: Push your changes to your forked repository. -7. **Create a Pull Request**: Submit a pull request to the original repository. Provide a detailed description of your changes, including any relevant issue numbers. - -### Review Process - -1. **Code Review**: Your pull request will be reviewed by project maintainers. They may request changes or ask for additional information. -2. **Respond to Feedback**: Address any feedback or changes requested by the maintainers in a timely manner. -3. **Approval and Merge**: Once your changes have been approved, they will be merged into the main branch. - -### Coding Standards - -- **Write Clear Comments**: Use comments to explain complex or non-obvious parts of your code. -- **Update Documentation**: If your changes affect the project's documentation, update it accordingly. - -### Additional Notes - -- **Be Respectful**: Treat other contributors and maintainers with respect. We value a welcoming and inclusive community. -- **Stay Updated**: Keep your fork and branch up to date with the latest changes from the main repository. - -Thank you for contributing to our project! Your efforts help make it better for everyone. - - ## License This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.