Skip to content

Commit 2cd542b

Browse files
authored
Merge pull request #2 from akohan91/doc/update-readme-file
Add detailed information how to contribute.
2 parents 1f10318 + 6922cd7 commit 2cd542b

File tree

1 file changed

+26
-4
lines changed

1 file changed

+26
-4
lines changed

README.md

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,11 +66,33 @@ The API Reference documentation is available [here](API_Reference.md). It provid
6666

6767
## 🤝 Contribution
6868

69-
We welcome contributions from the community! Here's how you can get involved:
69+
We welcome contributions! Heres how you can get started:
7070

71-
1. Fork this repository.
72-
2. Create a new branch for your feature or bug fix.
73-
3. Submit a pull request with a detailed description of your changes.
71+
1. **🍴 Fork the Repository**
72+
73+
2. **🌱 Create a New Branch**
74+
75+
Work on your changes in a separate branch.
76+
77+
Follow the branch naming conventions:
78+
79+
- ✨ For features: `feature/<branch-name>`
80+
- 🐛 For bug fixes: `bugfix/<branch-name>`
81+
- 📚 For documentation: `doc/<branch-name>`
82+
83+
3. **🔧 Make Changes and Test**
84+
85+
Implement your changes and ensure everything works.
86+
87+
4. **🚀 Push Your Changes**
88+
89+
Push your branch to your forked repository:
90+
91+
`git push origin your-branch-name`
92+
93+
5. **📬 Submit a Pull Request**
94+
95+
Open a pull request to the develop branch with a clear description of your changes.
7496

7597

7698
## 📝 License

0 commit comments

Comments
 (0)