From cb118f4dea8bc7c458a71bac7a71fd78c30d5d7e Mon Sep 17 00:00:00 2001 From: Khanh Ngo Date: Wed, 27 Dec 2023 10:08:00 +0100 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 67 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3b22f62 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,67 @@ +# Contributing Guidelines + +Thank you for your interest in contributing to my project. Whether it's a bug report, new feature, correction, or additional +documentation, I greatly value feedback and contributions from my community. + +Please read through this document before submitting any issues or pull requests to ensure I have all the necessary +information to effectively respond to your bug report or contribution. + +## Reporting Bugs/Feature Requests + +I welcome you to use the GitHub issue tracker to report bugs or suggest features. + +When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already +reported the issue. Please try to include as much information as you can. Details like these are incredibly useful: + +- A reproducible test case or series of steps +- The version of my code being used +- Any modifications you've made relevant to the bug +- Anything unusual about your environment or deployment + +## Contributing via Pull Requests + +### Discussion of New Features +Before initiating the implementation of a new feature, I encourage contributors to open a discussion by creating a new GitHub issue. This allows me to provide feedback, share insights, and ensure alignment with the project's direction and save your time. + +#### Process for Discussing New Features: + +1. **Create an Issue:** + - Go to the "Issues" tab in the repository. + - Click on "New Issue." + - Clearly describe the proposed feature, its purpose, and potential benefits. + +2. **Engage in Discussion:** + - Respond promptly to comments and feedback from the community. + - Be open to adjusting the feature based on collaborative input. + +3. **Consensus Building:** + - Strive to reach a consensus on the proposed feature. + - Ensure alignment with the overall project vision. + +### Bug Fixes and Improvements + +For bug fixes, documentation improvements, and general enhancements, feel free to submit a pull request directly. + +#### Pull Request Guidelines: + +1. **Fork the Repository:** + - Fork the repository to your GitHub account. + +2. **Create a Branch:** + - Create a new branch for your changes. + +3. **Make Changes:** + - Make your changes and ensure they adhere to coding standards. + +4. **Submit a Pull Request:** + - Submit a pull request to the main repository. + +5. **Engage in Review:** + - Be responsive to feedback and address any requested changes. + +6. **Merge Process:** + - Once approved, your changes will be merged into the main branch. + +## Licensing + +See the [LICENSE](LICENSE) file for my project's licensing.