From f0e40baaa71ca86c765d1b66784ad25be6530385 Mon Sep 17 00:00:00 2001 From: Yunus Date: Wed, 17 May 2023 21:28:30 +1000 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..698d7dc --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,38 @@ +# Contributing + +Thank you for considering contributing to this project! We appreciate your time and effort in helping make this project better. + +To contribute, please follow these guidelines: + +## Issues + +If you have any bug reports, feature requests, or other issues, please check the existing issues to see if a similar one has already been raised. If not, feel free to open a new issue and provide as much detail as possible, including steps to reproduce the issue or a clear description of the requested feature. + +## Pull Requests + +We welcome pull requests for bug fixes, enhancements, or new features. Before submitting a pull request, please make sure to follow these steps: + +1. Fork the repository and create a new branch for your feature or bug fix. +2. Make the necessary changes in your branch. +3. Ensure that your code adheres to the coding conventions and style guidelines of the project. +4. Write appropriate tests to cover your changes. +5. Update the documentation, if applicable. +6. Commit your changes and push them to your forked repository. +7. Submit a pull request to the main repository. + +Please provide a clear and descriptive title for your pull request, along with a detailed description of the changes made and the problem it addresses. + +## Code Style and Conventions + +To maintain consistency throughout the codebase, please follow the existing code style and conventions used in this project. This includes indentation, naming conventions, and documentation practices. If in doubt, refer to the existing code and documentation for guidance. + +## Code of Conduct + +Please note that by contributing to this project, you are expected to adhere to the [Code of Conduct](CODE_OF_CONDUCT.md). Be respectful and considerate towards others, and help us create a welcoming and inclusive environment for everyone. + +## License + +If you have any questions or need further assistance, feel free to reach out to the project maintainers or refer to the [README](README.md) file. + +We appreciate your contribution and look forward to your pull requests! +