Skip to content

Commit 09d9890

Browse files
docs: Add comprehensive development process workflow to AICodingAgent.md (issue #41) (#43)
This commit extends the guidelines document with a detailed step-by-step workflow that coding agents should follow throughout the development lifecycle. The workflow covers the complete cycle from branch creation through PR merge and cleanup, ensuring consistent development practices. Key additions: - 9-step development workflow section - Branch naming conventions - Review cycle iteration process - Post-merge cleanup instructions This structured approach helps maintain code quality and consistency across all contributions by providing clear guidance on the expected development process. Co-authored-by: florath-ai-assistant[bot] <Andreas.Florath@telekom.de>
1 parent 5e769c7 commit 09d9890

File tree

1 file changed

+59
-4
lines changed

1 file changed

+59
-4
lines changed

AICodingAgent.md

Lines changed: 59 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,62 @@
77

88
---
99

10-
## 1. Before Making ANY Changes (MANDATORY)
10+
## 1. Development Process Workflow
11+
12+
Follow this process for ALL development work:
13+
14+
### Step-by-Step Workflow
15+
16+
1. **Start from main branch**
17+
```bash
18+
git checkout main
19+
git pull origin main
20+
```
21+
22+
2. **Identify the task**
23+
- Observe what needs to be done (typically: resolve an issue)
24+
- Review the issue details and requirements
25+
26+
3. **Create a feature branch**
27+
```bash
28+
git checkout -b fix-issue-<number> # or feat-<description>
29+
```
30+
31+
4. **Develop, fix, and test**
32+
- Make your changes following all coding standards
33+
- Write or update tests as needed
34+
- Test locally during development
35+
36+
5. **Run all tests**
37+
```bash
38+
bash scripts/run-quality-checks.sh
39+
```
40+
- ALL checks MUST pass before proceeding
41+
42+
6. **Commit your changes**
43+
- Follow conventional commit format (see section 4 below)
44+
- Write clear commit messages explaining WHY
45+
46+
7. **Create a Pull Request**
47+
- Push your branch to GitHub
48+
- Create PR with proper description (see section 4 below)
49+
- Link the PR to the issue
50+
51+
8. **Review cycle**
52+
- Human reviewer will provide feedback
53+
- If there are comments or requested changes: **Go back to step 4**
54+
- Address all feedback and repeat steps 4-7 as needed
55+
56+
9. **Post-merge cleanup**
57+
- After PR is merged, run cleanup script:
58+
```bash
59+
./scripts/post-pr-merge.sh
60+
```
61+
- This cleans up everything locally and prepares for next task
62+
63+
---
64+
65+
## 2. Before Making ANY Changes (MANDATORY)
1166

1267
Read and follow ALL standards in:
1368

@@ -24,7 +79,7 @@ Also:
2479

2580
---
2681

27-
## 2. Pre-Commit Workflow (MANDATORY)
82+
## 3. Pre-Commit Workflow (MANDATORY)
2883

2984
Before ANY commit, run:
3085

@@ -40,7 +95,7 @@ bash scripts/run-quality-checks.sh
4095

4196
---
4297

43-
## 3. Commit and PR Format
98+
## 4. Commit and PR Format
4499

45100
### Commits
46101

@@ -64,7 +119,7 @@ Include:
64119

65120
---
66121

67-
## Summary Checklist
122+
## 5. Summary Checklist
68123

69124
**DO:**
70125
1. Read all `dev-notes/` documentation first

0 commit comments

Comments
 (0)