diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..d23f8de --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,40 @@ +# Contributing to [MindSpace](https://github.com/The-MindSpace/MindSpace-Web) + +Thank you for considering contributing to [MindSpace](https://github.com/The-MindSpace/MindSpace-Web) We welcome your help and appreciate your interest in improving our project. + +## How to Contribute + +### Reporting Bugs or Issues + +If you encounter a bug or have issues with the project, please open a GitHub issue with a clear and descriptive title. Provide as much detail as possible, including steps to reproduce the issue and any relevant error messages. + +### Feature Requests + +If you have an idea for a new feature, please open a GitHub issue with a clear title and description. We appreciate your input and would love to hear your ideas. + +### Pull Requests + +1. Fork the repository. +2. Create a new branch for your feature or bug fix: + ```bash + git checkout -b feature-branch +Please use a meaningful branch name. +3. Make your changes and ensure your code follows the project's coding standards. +- Write clear commit messages. +- Test your changes thoroughly. +- Push your branch to your fork: +```bash + git push origin feature-branch +``` +4. Open a pull request with a clear title and description. +## Code Style +Follow the existing code style of the project. If the project doesn't have a specific style guide, be consistent with the surrounding code. + +## Code of Conduct +Please note that this project is released with a [Contributor Code of Conduct](https://github.com/The-MindSpace/MindSpace-Web/blob/master/code_of_conduct.md). By participating in this project, you agree to abide by its terms. + +## License + +By contributing to this project, you agree that your contributions will be licensed under the [CCO 1.0 Universal License](https://github.com/The-MindSpace/MindSpace-Web/blob/master/LICENSE). + +Thank you for your contribution!