The Project is still in early developmental stages, Therefore, These guidelines are open to discussion and modification, Open an Issue on the Github Issue Tracker for Discussions
Ensure Commits are short and contain a descriptor flag to show what the commit did, such as feat: for features, docs for documentation, fix for fixes and patches.
The software aims to follow the Uber Style Guide in most if not all cases, The goal is to ensure a uniform style across the entire codebase and improve the Developer Experience in addition to making the codebase more accessible to interested researchers and new contributers, The entire style guide is available at: https://github.com/uber-go/guide/
New features are welcome and very much appreciated, However, to avoid clutter and out-of-scope development, It is often better to create an Issue or Github Discussion to discuss viability and use cases for said features. If a majority of maintainers and users would like the feature and believe it is in scope of development, Please create a Pull Request on the Github repository ensuring other relevant contributing guidelines are followed.
We really appreciate you testing and producing Patches for our software, Please create a Pull Request on Github with the patched code ensuring other relevant contributing guidelines are followed
Please refer to our Security Guidelines
While LLMs and AI are amazing software, We do not support or promote AI lead development, This is to ensure high levels of code quality and reliability, Therefore, Using AI to contribute code is NOT Allowed, However, Using AI for code reviews and Planning are within the realms of what we consider appropriate use of AI in our project. If any bugs or security vulnerabilities are discovered using AI, the reporter must provide a full disclosure and report the bugs and security vulnerabilities through the appropriate channels (Refer to our Security Guidelines for Vulnerabilities)
If using AI for messages or filing issues / vulnerabilities, ensure you do not use excessive formatting or excessive emojis also known as "emoji vomit", This makes it easier for maintainers to focus on the issue, Low quality bug reports or vulnerabilities will not be prioritised and may also be closed