From 6922cd70e2b8f1ad22afd30cfc4b14ad8df57020 Mon Sep 17 00:00:00 2001 From: Andrei Kakhanouski Date: Fri, 20 Dec 2024 11:02:03 +0100 Subject: [PATCH] Add detailed information how to contribute. --- README.md | 30 ++++++++++++++++++++++++++---- 1 file changed, 26 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8f20e50..7679bb6 100644 --- a/README.md +++ b/README.md @@ -66,11 +66,33 @@ The API Reference documentation is available [here](API_Reference.md). It provid ## 🀝 Contribution -We welcome contributions from the community! Here's how you can get involved: +We welcome contributions! Here’s how you can get started: -1. Fork this repository. -2. Create a new branch for your feature or bug fix. -3. Submit a pull request with a detailed description of your changes. +1. **🍴 Fork the Repository** + +2. **🌱 Create a New Branch** + +Work on your changes in a separate branch. + +Follow the branch naming conventions: + +- ✨ For features: `feature/` +- πŸ› For bug fixes: `bugfix/` +- πŸ“š For documentation: `doc/` + +3. **πŸ”§ Make Changes and Test** + +Implement your changes and ensure everything works. + +4. **πŸš€ Push Your Changes** + +Push your branch to your forked repository: + +`git push origin your-branch-name` + +5. **πŸ“¬ Submit a Pull Request** + +Open a pull request to the develop branch with a clear description of your changes. ## πŸ“ License