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

  • Skill Registry: Build a collection of prebuilt manifests for common use cases, such as project management, issue tracking, and more.
  • Improved Error management: Enhance the error handling capabilities of integration APIs to provide better feedback and debugging information.
  • Auto Generation of manifest files: Explore ways to automatically generate manifest files based on user input or existing API spec.
  • Local Function: Implement local functions that dont need an API to be called, such as file system operations, data processing, etc.
  • Documentation: Help improve the documentation by fixing typos, adding examples, or clarifying existing content.

How to Contribute

  1. Fork the Repository: Start by forking the repository to your own GitHub account.
  2. Clone the Fork: Clone your forked repository to your local machine.
  3. 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.
  4. Make Changes: Implement your changes in the codebase. Ensure that your code adheres to the project’s coding standards and conventions.
  5. 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.
  6. Commit Your Changes: Commit your changes with a clear and concise commit message that describes the changes you made.
  7. Push Your Changes: Push your changes to your forked repository on GitHub.
  8. 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.