cevheri commited on
Commit
8a6a95d
Β·
1 Parent(s): 6d854d8

docs: add contributing.md file for contributors

Browse files
Files changed (1) hide show
  1. CONTRIBUTING.md +85 -0
CONTRIBUTING.md ADDED
@@ -0,0 +1,85 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # 🀝 How to Contribute
2
+ We welcome contributions from the community! Whether you're fixing a bug, adding a feature, or improving documentation, your help is greatly appreciated.
3
+
4
+ Please take a moment to read through these guidelines before submitting a pull request or issue.
5
+
6
+ ## 🧩 Contribution Types We Accept
7
+ * Bug fixes
8
+ * New features (must align with project roadmap)
9
+ * Documentation improvements
10
+ * Code refactoring and optimization
11
+ * Testing improvements (unit tests, integration tests)
12
+ * Example use cases or tutorials
13
+
14
+ ## πŸ“Œ Forking the Repository
15
+ 1. Fork the repository
16
+ 2.
17
+
18
+ ## πŸ“Œ Submitting a Pull Request (PR)
19
+ 1. Fork the repository from GitHub
20
+ 2. Clone the repository to your local machine
21
+ ```bash
22
+ git clone https://github.com/your-username/your-repo.git
23
+ ```
24
+ 2. Create a new branch :
25
+ ```bash
26
+ git checkout -b feature/your-feature-name
27
+ ```
28
+ 3. Make your changes
29
+ 4. Test your changes thoroughly
30
+ 5. Commit your changes with a clear and descriptive message:
31
+ ```bash
32
+ git commit -m "Fix bug in chatbot response handling"
33
+ ```
34
+ 6. Push to your fork
35
+ ```bash
36
+ git push origin feature/your-feature-name
37
+ ```
38
+ 7. Open a PR on the original repository
39
+ 8. Wait for review and feedback
40
+ 9. Please follow the README.md instructions for run and commit the changes.
41
+
42
+ ## πŸ“Œ Code Style and Formatting
43
+ * Follow the existing code style and formatting
44
+ * Use meaningful variable and function names
45
+ * Add comments to explain complex code
46
+ * Keep code clean and readable
47
+
48
+
49
+ ## πŸ“š Documentation Guidelines
50
+ If you're updating or writing documentation:
51
+ * Use clear and concise language
52
+ * Keep examples simple but practical
53
+ * Ensure all code examples are working and up-to-date
54
+
55
+
56
+ ## πŸ› Reporting Bugs / Suggesting Features
57
+ Use the GitHub Issues section to report bugs or suggest enhancements.
58
+
59
+ When reporting a bug, please include:
60
+
61
+ A clear title and description
62
+ Steps to reproduce
63
+ Expected behavior vs actual behavior
64
+ Environment info (OS, Python version, etc.)
65
+ For feature requests, please describe:
66
+
67
+ The problem you're trying to solve
68
+ How the feature would improve the project
69
+ Any alternative solutions considered
70
+ πŸ“š Documentation Guidelines
71
+ If you're updating or writing documentation:
72
+
73
+ Use clear and concise language
74
+ Keep examples simple but practical
75
+ Ensure all code examples are working and up-to-date
76
+ πŸ” Licensing
77
+ By contributing to this project, you agree that your contributions will be licensed under the Apache 2.0 License .
78
+
79
+ All contributions must be your own original work or clearly indicate if derived from another source.
80
+
81
+ πŸ§‘β€βš–οΈ Code of Conduct
82
+ We expect all contributors to follow our Code of Conduct . Please treat others with respect and keep the environment welcoming and inclusive.
83
+
84
+ πŸ™Œ Thank You!
85
+ Your contribution helps make this project better for everyone. We appreciate your time and effort.