Kosasih commited on
Commit
bfa8d21
·
verified ·
1 Parent(s): 4feedd0

Create CONTRIBUTING.md

Browse files
Files changed (1) hide show
  1. CONTRIBUTING.md +60 -0
CONTRIBUTING.md ADDED
@@ -0,0 +1,60 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Contributing to OmniCoreX
2
+
3
+ Thank you for your interest in contributing to OmniCoreX! Your contributions help us improve and evolve the ultimate AI brain.
4
+
5
+ ## How Can You Contribute?
6
+
7
+ ### Reporting Issues
8
+ - If you encounter bugs, inconsistencies, or have feature requests, please open an issue on GitHub with a clear description and steps to reproduce if applicable.
9
+ - Use descriptive titles and provide context to help us understand the problem better.
10
+
11
+ ### Suggesting Enhancements
12
+ - Propose improvements by opening a feature request issue.
13
+ - Discuss your ideas with the community before implementation if significant changes are involved.
14
+
15
+ ### Submitting Code Contributions
16
+ - Fork the repository and create your branch from `main`.
17
+ - Ensure your code adheres to the existing coding style and is well-documented.
18
+ - Write tests for new features or bug fixes to maintain code quality.
19
+ - Keep your commits focused and descriptive.
20
+ - Submit a pull request detailing your changes and the motivation behind them.
21
+
22
+ ### Documentation Improvements
23
+ - Help us keep the documentation clear and comprehensive by fixing typos, improving explanations, or adding examples.
24
+ - Documentation updates follow the same contribution process as code.
25
+
26
+ ## Code Standards and Guidelines
27
+
28
+ - Follow PEP 8 for Python code style.
29
+ - Write clean, readable, and maintainable code.
30
+ - Include inline comments where necessary to explain complex logic.
31
+ - Ensure new features do not break existing functionality; run all tests before submitting.
32
+
33
+ ## Testing
34
+
35
+ - Run all existing tests and add new tests for your changes if applicable.
36
+ - Use `unittest` or the testing framework used in the project.
37
+ - Ensure tests pass locally before submitting.
38
+
39
+ ## Review Process
40
+
41
+ - All pull requests are reviewed by the maintainers.
42
+ - Feedback may be provided and changes requested.
43
+ - Be responsive and collaborative to suggestions and improvements.
44
+
45
+ ## Code of Conduct
46
+
47
+ - Please respect all community members.
48
+ - Maintain a welcoming and inclusive environment.
49
+ - Report any unacceptable behavior directly to the maintainers.
50
+
51
+ ## Contact
52
+
53
+ If you have any questions or need guidance on contributing, feel free to reach out via GitHub Discussions or contact us at support@omnicorex.ai.
54
+
55
+ ---
56
+
57
+ Together, let's make OmniCoreX the most advanced and impactful AI system ever created!
58
+
59
+ Thank you for contributing!
60
+