| # Contributing to OmniCoreX | |
| Thank you for your interest in contributing to OmniCoreX! Your contributions help us improve and evolve the ultimate AI brain. | |
| ## How Can You Contribute? | |
| ### Reporting Issues | |
| - 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. | |
| - Use descriptive titles and provide context to help us understand the problem better. | |
| ### Suggesting Enhancements | |
| - Propose improvements by opening a feature request issue. | |
| - Discuss your ideas with the community before implementation if significant changes are involved. | |
| ### Submitting Code Contributions | |
| - Fork the repository and create your branch from `main`. | |
| - Ensure your code adheres to the existing coding style and is well-documented. | |
| - Write tests for new features or bug fixes to maintain code quality. | |
| - Keep your commits focused and descriptive. | |
| - Submit a pull request detailing your changes and the motivation behind them. | |
| ### Documentation Improvements | |
| - Help us keep the documentation clear and comprehensive by fixing typos, improving explanations, or adding examples. | |
| - Documentation updates follow the same contribution process as code. | |
| ## Code Standards and Guidelines | |
| - Follow PEP 8 for Python code style. | |
| - Write clean, readable, and maintainable code. | |
| - Include inline comments where necessary to explain complex logic. | |
| - Ensure new features do not break existing functionality; run all tests before submitting. | |
| ## Testing | |
| - Run all existing tests and add new tests for your changes if applicable. | |
| - Use `unittest` or the testing framework used in the project. | |
| - Ensure tests pass locally before submitting. | |
| ## Review Process | |
| - All pull requests are reviewed by the maintainers. | |
| - Feedback may be provided and changes requested. | |
| - Be responsive and collaborative to suggestions and improvements. | |
| ## Code of Conduct | |
| - Please respect all community members. | |
| - Maintain a welcoming and inclusive environment. | |
| - Report any unacceptable behavior directly to the maintainers. | |
| ## Contact | |
| 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. | |
| --- | |
| Together, let's make OmniCoreX the most advanced and impactful AI system ever created! | |
| Thank you for contributing! | |