From 858f7563cb44abf4dbe3063f8b267f4adef85e91 Mon Sep 17 00:00:00 2001 From: SrJss <31166687+jonagamerpro1234@users.noreply.github.com> Date: Wed, 12 Apr 2023 16:44:30 -0400 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..7b041ab --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,35 @@ +# Contributing Guidelines + +Thank you for considering contributing to our project! Feel free to propose improvements, report issues, or add new features. To contribute, please follow these steps: + +1. Fork this repository. +2. Clone the fork to your local machine. +3. Create a new branch for your changes: `git checkout -b branch-name`. +4. Make the changes and commit them: `git add .` and `git commit -m "Description of the changes made"`. +5. Push the changes to your fork: `git push origin branch-name`. +6. Create a Pull Request towards the main branch of this repository. + +## How to contribute + +You can contribute in several ways, including: + +- Reporting issues or problems in the code. +- Adding new features. +- Correcting grammar or spelling errors in documentation files. +- Improving code efficiency. + +## How to report issues or suggest improvements + +If you find any errors or problems in the code, or if you have any suggestions for improving the project, you can inform us by opening an Issue. Please make sure to provide as much detail as possible about the problem or suggestion so that we can address it effectively. + +## Contribution guidelines + +Before making a contribution, please make sure to review and follow these guidelines: + +- All changes must be clearly documented. +- Code must follow existing style conventions. +- You must add tests for any new features you add. + +## License + +This project is licensed under the **GNU General Public License v3.0**. By contributing to this project, you agree that your contribution will be published under the same license.