Skip to content
This repository was archived by the owner on Mar 9, 2026. It is now read-only.

Commit 39ce0bf

Browse files
committed
Add documentation for AICodeBot Code Agent feature
This commit introduces a new markdown file, `docs/code_agent.md`, which provides comprehensive documentation for the AICodeBot Code Agent feature. The document outlines the various steps involved in the code generation process, from task understanding to code review. It also highlights the future plans for reinforcement learning and active learning. 📚🤖
1 parent 42348b5 commit 39ce0bf

File tree

2 files changed

+52
-13
lines changed

2 files changed

+52
-13
lines changed

README.md

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -34,19 +34,9 @@ It's also not a "build a site for me in 5 minutes" tool that takes a well constr
3434

3535
### AI-Assisted Code Creation (Work in Progress)
3636

37-
`aicodebot code` is a feature designed to automate coding tasks based on your instructions. It's a work in progress, but here's how it works:
38-
39-
1. **Task Understanding**: The bot collects your task instructions.
40-
2. **Planning**: It devises a plan based on your task.
41-
3. **Learning**: It learns necessary information by searching the internet, reading the local codebase, and researching libraries/APIs.
42-
4. **Clarification**: It asks questions if any aspect of the task is unclear.
43-
5. **Code Generation**: It generates code consistent with your codebase style.
44-
6. **Self-Review**: It reviews and improves the generated code.
45-
7. **Code Modification**: It modifies the local code, allowing you to review changes before committing.
46-
8. **Test Creation**: It writes and runs unit tests for the new code, modifying the code until all tests pass.
47-
9. **Continuous Learning (v2)**: We plan to implement a system where the bot learns from each interaction, improving its performance over time based on feedback like code acceptance, compilation success, and test results.
48-
49-
This feature is a work in progress, and we're excited about its potential to boost developer productivity. If you'd like to help, see [CONTRIBUTING](CONTRIBUTING.md).
37+
The aicodebot code feature is an AI-powered tool that automates coding tasks. It understands your task, formulates a plan, learns necessary information, and generates code that fits your codebase style. It also reviews its own work, modifies the local code, and creates unit tests. This feature is designed to streamline your coding process and boost productivity. In the future, we plan to enhance its performance through a continuous learning system based on user feedback and interaction outcomes.
38+
39+
This feature is a work in progress, and it's more thoroughly documented [here](docs/code_agent.md) and we're excited about its potential to boost developer productivity. If you'd like to help, see [CONTRIBUTING](CONTRIBUTING.md).
5040

5141
## Getting Started
5242

docs/code_agent.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# AICodeBot Code Agent
2+
3+
The 'code' command is a new feature of AICodeBot designed to automate coding
4+
tasks based on instructions from you. This feature aims to boost developer
5+
productivity by handling various aspects of the coding process, but keeping you
6+
in charge of the process.
7+
8+
## Feature Overview
9+
10+
`aicodebot code` has several steps:
11+
12+
1. **Task Understanding**: AICodeBot interprets the coding task by prompting you
13+
for requirements.
14+
15+
2. **Planning**: AICodeBot devises a plan of action for the task, identifying
16+
the necessary steps and potential challenges, and determining where it needs
17+
clarification on the requirements.
18+
19+
3. **Learning**: AICodeBot gathers the information required to complete the
20+
task. This includes researching the best approach, understanding the existing
21+
codebase and architecture, and learning about necessary libraries or APIs.
22+
23+
4. **Clarification**: If any aspect of the task is unclear, AICodeBot asks
24+
clarifying questions to ensure a comprehensive understanding of the task.
25+
Great engineers know how to talk to the customer to see what they want.
26+
27+
5. **Code Generation**: AICodeBot generates code that aligns with the style of
28+
the existing codebase, following conventions and best practices.
29+
30+
6. **Self-Review**: AICodeBot reviews and improves the generated code,
31+
identifying potential issues or areas for enhancement. Note: This practice
32+
of self-reflection has been shown to boost the effectiveness of AI systems.
33+
34+
7. **Code Modification**: AICodeBot modifies the local code with the new
35+
changes, making them available for review with a diff.
36+
37+
8. **Unit Testing**: AICodeBot writes and runs unit tests for the new code,
38+
debugging and modifying the code as necessary until all tests pass.
39+
40+
9. **Code Review**: AICodeBot submits the code for review, and marks the task
41+
as complete and ready for you to commit.
42+
43+
**Future** - Reinforcement Learning and Active Learning
44+
45+
AICodeBot is designed to learn from each interaction, improving its performance
46+
over time based on feedback like code acceptance, compilation success, and passing
47+
test results.
48+
49+
[![](https://mermaid.ink/img/pako:eNp1lMFuozAQhl9l5JVyaq97yGFXDWSjSEnLhkSrVenBxUNi1djUNq1Q1XffMZg0rZYLgpnf38z8Nn5jpRHI5uxoeXMqNMBhd1-wgxZonedawJ67J9jhcyst1qi9K9gDXF__gIR0OeITJIpbWcmSe2k0VNbUcHBoSRd4CYmhYCv0fRTWuml9wQbEheCyBMT6xoiozKhYprgGf8K-pUjPhsVrQctk1UHusXEwg-TElUJ9RBcBGwJskFsNt1iic9x21EplbN23HXGbsRdH0vIEC3QebprGGk5fM7jJ1iMwWd2HqTRa7hEScnEceDVAEotjhh7aSeepSXiV_tQHH7nDyMqD5zt8kfgKwfN1TRVfPlHz3ZdJMxNwkqtRHTdnaG5LwK0RQbgxJYkuG9wOqMzSmNQReRWMAjIDhiYi5bAnyh8raYoZ7FpN2yI97MkTF1GH_YBaatfaOOvvlivpu8hICZHiY3sEWX1YH5encaZQ3sNd6-loUKleP64PO5-aoSpk3Lmf4-K493_Pe7zsXeSi60dJTF1L_0V8a0ZuiDrfKaQTD5VUav7t-3KxSH99JJKJeDYR30xxVhOJfLLydiJBhv8_kU7Fp5pdfoqzK1Yj_QtS0F3wFlQFo1-tpjMzp1eBFW8VmVnod5Ly1pu80yWbe9viFWsbQUc9lZxukZrNK67cOboU0ht7DmL_uR0unf7uef8H0zJtIQ?type=png)](https://mermaid.live/edit#pako:eNp1lMFuozAQhl9l5JVyaq97yGFXDWSjSEnLhkSrVenBxUNi1djUNq1Q1XffMZg0rZYLgpnf38z8Nn5jpRHI5uxoeXMqNMBhd1-wgxZonedawJ67J9jhcyst1qi9K9gDXF__gIR0OeITJIpbWcmSe2k0VNbUcHBoSRd4CYmhYCv0fRTWuml9wQbEheCyBMT6xoiozKhYprgGf8K-pUjPhsVrQctk1UHusXEwg-TElUJ9RBcBGwJskFsNt1iic9x21EplbN23HXGbsRdH0vIEC3QebprGGk5fM7jJ1iMwWd2HqTRa7hEScnEceDVAEotjhh7aSeepSXiV_tQHH7nDyMqD5zt8kfgKwfN1TRVfPlHz3ZdJMxNwkqtRHTdnaG5LwK0RQbgxJYkuG9wOqMzSmNQReRWMAjIDhiYi5bAnyh8raYoZ7FpN2yI97MkTF1GH_YBaatfaOOvvlivpu8hICZHiY3sEWX1YH5encaZQ3sNd6-loUKleP64PO5-aoSpk3Lmf4-K493_Pe7zsXeSi60dJTF1L_0V8a0ZuiDrfKaQTD5VUav7t-3KxSH99JJKJeDYR30xxVhOJfLLydiJBhv8_kU7Fp5pdfoqzK1Yj_QtS0F3wFlQFo1-tpjMzp1eBFW8VmVnod5Ly1pu80yWbe9viFWsbQUc9lZxukZrNK67cOboU0ht7DmL_uR0unf7uef8H0zJtIQ)

0 commit comments

Comments
 (0)