How to Contribute to Our Open Source Project

We're excited that you're interested in contributing to our project! This guide will help you get started with contributing to Kaizen.

Table of Contents

1. Getting Started
2. Setting Up Your Development Environment
3. Finding Issues to Work On
4. Making Changes
5. Submitting a Pull Request
6. Code Review Process
7. Community Guidelines

Getting Started

1. Fork the Repository: Start by forking our repository to your GitHub account.

2. Clone Your Fork: Clone your fork to your local machine:

   git clone https://github.com/your-username/project-name.git
   cd project-name

3. Add Upstream Remote: Add the original repository as an upstream remote:

   git remote add upstream https://github.com/Cloud-Code-AI/kaizen.git

Setting Up Your Development Environment

1. Install Dependencies: Follow the instructions in our README.md to install necessary dependencies.

   poetry install

2. Create a Branch: Create a new branch for your work:

   git checkout -b feature/your-feature-name

Finding Issues to Work On

• Check our Issues (opens in a new tab) page for open issues.
• Look for issues tagged with good first issue or help wanted.
• If you have an idea for a new feature, open an issue to discuss it before starting work.

Making Changes

1. Write Your Code: Make your changes, following our coding standards and guidelines.

2. Write Tests: Add or update tests as necessary.

3. Run Tests: Ensure all tests pass:

   pytest .

4. Commit Your Changes: Use clear and concise commit messages:

   git commit -m "Add feature: brief description of changes"

Submitting a Pull Request

1. Push Your Changes: Push your branch to your fork:

   git push origin feature/your-feature-name

2. Open a Pull Request: Go to the original repository on GitHub and open a pull request.

3. Describe Your Changes: In the PR description, explain your changes and link to any relevant issues.

Code Review Process

1. Maintainers will review your PR and may request changes.
2. Address any comments or requested changes.
3. Once approved, a maintainer will merge your PR.

Community Guidelines

• Be respectful and inclusive in your interactions with other contributors.
• Follow our Code of Conduct.
• Participate in discussions and help other contributors.

Additional Resources

• Project Documentation (opens in a new tab)
• Coding Standards (opens in a new tab)
• Join Our Community Chat (opens in a new tab)

Thank you for contributing to our project! Your efforts help make our software better for everyone.