From 1958cf14ea186e625fd38431458b518991689daf Mon Sep 17 00:00:00 2001 From: Martin <49105846+Fosowl@users.noreply.github.com> Date: Tue, 11 Mar 2025 09:48:52 +0100 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..d4b720e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,55 @@ +# Contributors guide + +## Prerequisites + +- Python 3.8 or higher +- Ollama installed (for local model execution) +- Basic familiarity with Python and AI models + +## Contribution Guidelines + +We welcome contributions in the following areas: + +- Code Improvements: Optimize existing code, fix bugs, or add new features. +- Documentation: Improve the README, write tutorials, or add inline comments. +- Testing: Write unit tests, integration tests, or help with debugging. +- New Features: Implement new tools, agents, or integrations. + +## Steps to Contribute + +Fork the project to your GitHub account. + +Create a Branch: + +```bash +git checkout -b feature/your-feature-name +``` + +Make Your Changes. + +Write your code, add documentation, or fix bugs. + +Test Your Changes. + +Ensure your changes work as expected and do not break existing functionality. + +Push your changes to your fork and submit a pull request to the main branch of this repository. Provide a clear description of your changes and reference any related issues. + +## Areas Needing Help + +Here are some high-priority tasks and areas where we need contributions: + +- Web Browsing: Implement autonomous web browsing capabilities for the assistant. +- Multi-Agent System: Enhance the multi-agent functionality on the dev branch. +- Memory & Recovery: Improve conversation compression. +- New Tools: Add support for additional programming languages or APIs. +- Testing: Write comprehensive tests for existing and new features. + + +If you're unsure where to start, feel free to reach out by opening an issue or joining our community discussions. + +## Code of Conduct + +just be nice to each other. + +**Thank You!**