Skip to main content

Contribute Code

Contribute Code to TaskingAI Welcome to the TaskingAI code contribution guide! We are excited to have you on board. To ensure a smooth and efficient development process, we ask that all contributors adhere to the following guidelines.

🚀 Fork and Pull Request Workflow

  • Forking: To contribute code, please use the "fork and pull request" workflow. Start by forking the TaskingAI repository.
  • No Direct Pushes: Please avoid pushing directly to the TaskingAI repository unless you're a designated maintainer.

📝 Pull Request Guidelines

  • Template: When opening pull requests, follow the template provided in the repository. This helps in tracking related issues and notifying relevant maintainers.
  • Checks: Pull requests must pass formatting, linting, and testing checks before they can be merged. See below sections for running these checks locally.

🔧 Code Contributions Your contributions can be in various forms, including bug fixes, improvements, or new features. Each type has specific requirements:

  1. Bug Fixes:

    • Add relevant unit or integration tests whenever possible.
    • These tests should be located in tests/unit_tests and tests/integration_tests.

  2. Improvements:

    • Update any impacted example notebooks and documentation, located in docs.
    • Update unit and integration tests where relevant.

  3. New Features:

    • Add a demo notebook in docs/docs/.
    • Include necessary unit and integration tests.

We appreciate your contributions and efforts to improve TaskingAI. By following these guidelines, we can work together to create a more robust and effective AI platform. Happy coding!