Skip to content

Commit 4e28766

Browse files
sauravpandasauravpanda
authoredAug 2, 2024··
Merge pull request #367 from Cloud-Code-AI/364-feedback-for-how-to-contribute
doc: added more info on how to contribute
·
v0.4.21v0.3.17
2 parents ece92e4 + f6fd13e commit 4e28766

File tree

3 files changed

+218
-1
lines changed

3 files changed

+218
-1
lines changed
 

‎docs/pages/contributing/code_of_conduct.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,4 @@ Examples of unacceptable behavior by participants include:
2424

2525
## Enforcement
2626

27-
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [INSERT EMAIL ADDRESS]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
27+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at oss@cloudcode.ai . All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

‎docs/pages/contributing/development_setup.mdx

+112
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
---
2+
title: 'Kaizen Development Setup Guide'
3+
description: 'A guide to setting up the Kaizen development environment'
4+
---
5+
6+
# Kaizen Development Setup Guide
7+
8+
This guide will walk you through the process of setting up the Kaizen development environment.
9+
10+
## Step 1: Clone the Repository
11+
12+
First, clone the Kaizen repository from GitHub:
13+
14+
```bash
15+
git clone https://github.com/your-username/kaizen.git
16+
cd kaizen
17+
```
18+
19+
## Step 2: Set Up Environment Variables
20+
21+
Copy the `.env.example` file to create a new `.env` file:
22+
23+
```bash
24+
cp .env.example .env
25+
```
26+
27+
Make sure to fill in the necessary environment variables in the `.env` file.
28+
29+
## Step 3: Configure `config.json`
30+
31+
Create a `config.json` file in the root directory of the project. The general structure should look like this:
32+
33+
```json
34+
{
35+
"language_model": {
36+
"provider": "litellm",
37+
"enable_observability_logging": true,
38+
"redis_enabled": true,
39+
"models": [
40+
{
41+
"model_name": "default",
42+
"litellm_params": {
43+
"model": "gpt-4o-mini",
44+
"input_cost_per_token": 0.000000015,
45+
"output_cost_per_token": 0.0000006
46+
}
47+
},
48+
{
49+
"model_name": "best",
50+
"litellm_params": {
51+
"model": "gpt-4o",
52+
"input_cost_per_token": 0.000005,
53+
"output_cost_per_token": 0.000015
54+
}
55+
},
56+
{
57+
"model_name": "CUSTOM_MODEL",
58+
"litellm_params": {
59+
"model": "azure_ai/MODEL_NAME",
60+
"api_key": "os.environ/CUSTOM_API_KEY",
61+
"api_base": "os.environ/CUSTOM_API_BASE"
62+
},
63+
"model_info": {
64+
"max_tokens": 4096,
65+
"input_cost_per_token": 0.000015,
66+
"output_cost_per_token": 0.000015,
67+
"max_input_tokens": 128000,
68+
"max_output_tokens": 4096,
69+
"litellm_provider": "openai",
70+
"mode": "chat"
71+
}
72+
}
73+
]
74+
},
75+
"github_app": {
76+
"check_signature": false,
77+
"auto_pr_review": true,
78+
"edit_pr_desc": true,
79+
"process_on_push": true,
80+
"auto_unit_test_generation": false
81+
}
82+
}
83+
```
84+
85+
### Configuration Notes:
86+
87+
- `model_name` is the type of model used for routing. You can have multiple models with the same `model_name`.
88+
- `litellm_params.model` is the actual model name by provider. Refer to the LiteLLM documentation for more details.
89+
- All API keys should be set up in the `.env` file.
90+
- You can set up custom models with custom API keys and base names.
91+
92+
## Step 4: Running Examples
93+
94+
Once the setup is complete, you can run any example using the following command:
95+
96+
```bash
97+
PYTHONPATH=. poetry run python examples/basic/generate.py
98+
```
99+
100+
## Development and Testing
101+
102+
To test any development changes:
103+
104+
1. Feel free to update the examples as they use the local Kaizen files.
105+
2. Create your own tests in the `tests` directory.
106+
107+
## Additional Resources
108+
109+
- [LiteLLM Documentation](https://litellm.com/docs/)
110+
- [Kaizen GitHub Repository](https://github.com/Cloud-Code-Ai/kaizen)
111+
112+
For more information or if you encounter any issues, please refer to the project's documentation or create an issue on the GitHub repository.

‎docs/pages/contributing/how_to_contribute.mdx

+105
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
---
2+
title: 'How to Contribute to Our Open Source Project'
3+
description: 'A guide for developers looking to contribute to our open source software project'
4+
---
5+
6+
# How to Contribute to Our Open Source Project
7+
8+
We're excited that you're interested in contributing to our project! This guide will help you get started with contributing to Kaizen.
9+
10+
## Table of Contents
11+
12+
1. [Getting Started](#getting-started)
13+
2. [Setting Up Your Development Environment](#setting-up-your-development-environment)
14+
3. [Finding Issues to Work On](#finding-issues-to-work-on)
15+
4. [Making Changes](#making-changes)
16+
5. [Submitting a Pull Request](#submitting-a-pull-request)
17+
6. [Code Review Process](#code-review-process)
18+
7. [Community Guidelines](#community-guidelines)
19+
20+
## Getting Started
21+
22+
1. **Fork the Repository**: Start by forking our repository to your GitHub account.
23+
24+
2. **Clone Your Fork**: Clone your fork to your local machine:
25+
26+
```bash
27+
git clone https://github.com/your-username/project-name.git
28+
cd project-name
29+
```
30+
31+
3. **Add Upstream Remote**: Add the original repository as an upstream remote:
32+
33+
```bash
34+
git remote add upstream https://github.com/Cloud-Code-AI/kaizen.git
35+
```
36+
37+
## Setting Up Your Development Environment
38+
39+
1. **Install Dependencies**: Follow the instructions in our README.md to install necessary dependencies.
40+
41+
```bash
42+
poetry install
43+
```
44+
45+
2. **Create a Branch**: Create a new branch for your work:
46+
47+
```bash
48+
git checkout -b feature/your-feature-name
49+
```
50+
51+
## Finding Issues to Work On
52+
53+
- Check our [Issues](https://github.com/Cloud-Code-AI/kaizen/issues) page for open issues.
54+
- Look for issues tagged with `good first issue` or `help wanted`.
55+
- If you have an idea for a new feature, open an issue to discuss it before starting work.
56+
57+
## Making Changes
58+
59+
1. **Write Your Code**: Make your changes, following our coding standards and guidelines.
60+
61+
2. **Write Tests**: Add or update tests as necessary.
62+
63+
3. **Run Tests**: Ensure all tests pass:
64+
65+
```bash
66+
pytest .
67+
```
68+
69+
4. **Commit Your Changes**: Use clear and concise commit messages:
70+
71+
```bash
72+
git commit -m "Add feature: brief description of changes"
73+
```
74+
75+
## Submitting a Pull Request
76+
77+
1. **Push Your Changes**: Push your branch to your fork:
78+
79+
```bash
80+
git push origin feature/your-feature-name
81+
```
82+
83+
2. **Open a Pull Request**: Go to the original repository on GitHub and open a pull request.
84+
85+
3. **Describe Your Changes**: In the PR description, explain your changes and link to any relevant issues.
86+
87+
## Code Review Process
88+
89+
1. Maintainers will review your PR and may request changes.
90+
2. Address any comments or requested changes.
91+
3. Once approved, a maintainer will merge your PR.
92+
93+
## Community Guidelines
94+
95+
- Be respectful and inclusive in your interactions with other contributors.
96+
- Follow our [Code of Conduct](LINK_TO_CODE_OF_CONDUCT.md).
97+
- Participate in discussions and help other contributors.
98+
99+
## Additional Resources
100+
101+
- [Project Documentation](https://cloudcode.ai/kaizen/docs/)
102+
- [Coding Standards](https://cloudcode.ai/kaizen/docs/contributing/code_of_conduct)
103+
- [Join Our Community Chat](https://discord.gg/W33Hh5yWpj)
104+
105+
Thank you for contributing to our project! Your efforts help make our software better for everyone.

0 commit comments

Comments
 (0)
Please sign in to comment.