YAFAI-Core Documentation
Contributing
Core Engine for Multi Agent Orchestration
Contributing to the Core Engine
YAFAI-Core is an open-source project, and contributions are welcome! Whether you’re a developer, designer, or just someone who wants to help out, there are many ways you can contribute.
Areas actively being developed
- Orchestration Flow: Help improve the orchestration flow by suggesting new features, fixing bugs, or optimizing existing processes.
- Providers: Contribute by adding new LLM providers, enhancing existing ones, or fixing issues related to provider integration.
- Prompt Tuning: Contribute in refining the orchestration prompts and agents prompt template.
- Documentation: Help improve the documentation by fixing typos, adding examples, or clarifying existing content.
How to Contribute
- Fork the Repository: Start by forking the repository to your own GitHub account.
- Clone the Fork: Clone your forked repository to your local machine.
- Create a Branch: Create a new branch for your changes. Use a descriptive name for the branch that reflects the changes you plan to make.
- Make Changes: Implement your changes in the codebase. Ensure that your code adheres to the project’s coding standards and conventions.
- Test Your Changes: Run the tests to ensure that your changes do not break any existing functionality. Add new tests if you are implementing new features.
- Commit Your Changes: Commit your changes with a clear and concise commit message that describes the changes you made.
- Push Your Changes: Push your changes to your forked repository on GitHub.
- Create a Pull Request: Open a pull request from your branch to the main branch of the original repository. Provide a detailed description of your changes and why they are needed.