Skip to content

Commit a36647b

Browse files
Add PROJECT_STATE.md and DEVELOPMENT_PROCESS.md
1 parent 3f6050b commit a36647b

2 files changed

Lines changed: 113 additions & 0 deletions

File tree

docs/DEVELOPMENT_PROCESS.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Development Process
2+
3+
## Overview
4+
This project follows a collaborative development workflow involving **mnyon-grandkru** and **gktreviewer**.
5+
6+
## Workflow
7+
8+
### 1. Branch Naming
9+
- `feature/<description>` - New features
10+
- `fix/<description>` - Bug fixes
11+
- `refactor/<description>` - Code refactoring
12+
- `docs/<description>` - Documentation updates
13+
14+
### 2. Making Changes
15+
1. Create a new branch from `main`:
16+
```bash
17+
git checkout -b feature/your-feature-name
18+
```
19+
20+
2. Make your changes and commit them:
21+
```bash
22+
git add .
23+
git commit -m "Description of changes"
24+
```
25+
26+
3. Push your branch to remote:
27+
```bash
28+
git push -u origin feature/your-feature-name
29+
```
30+
31+
### 3. Pull Requests
32+
1. Open a Pull Request on GitHub as **mnyon-grandkru**
33+
2. Request review from **gktreviewer**
34+
3. Fill out the PR template if one exists
35+
36+
### 4. Code Review Process
37+
- All changes require approval from **gktreviewer** before merging
38+
- Reviewer will:
39+
- Review code for correctness
40+
- Check for code quality and style
41+
- Verify tests pass
42+
- Leave comments if changes are needed
43+
- Approval format: **LGTM** (Looks Good To Me)
44+
45+
### 5. Merging
46+
- After receiving LGTM from **gktreviewer**, **mnyon-grandkru** merges the PR
47+
- Squash and merge preferred for clean history
48+
- Delete branch after merging
49+
50+
### 6. Keeping Feature Branches Updated
51+
- When `main` is updated, feature branches are automatically rebased
52+
- To manually rebase your feature branch onto latest `main`:
53+
```bash
54+
git checkout feature/your-feature-name
55+
git fetch origin
56+
git rebase origin/main
57+
```
58+
59+
## Testing
60+
- Run tests before submitting PR:
61+
```bash
62+
# Add your test command here
63+
```
64+
65+
## Deployment
66+
- Deployment steps go here (if applicable)
67+
68+
## Questions?
69+
Reach out to **mnyon-grandkru** or **gktreviewer** for clarifications.

docs/PROJECT_STATE.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# PROJECT STATE
2+
3+
## Project Type
4+
- Client / Product / Internal / Experiment
5+
6+
## Current Phase
7+
- Planning / Building / Refactoring / Testing / Deploying / Maintenance
8+
9+
## Current Goal
10+
Clear single outcome for this phase.
11+
12+
## Definition of Done (Phase)
13+
-
14+
-
15+
-
16+
17+
## Current Branch
18+
-
19+
20+
## Last Completed Step
21+
-
22+
23+
## Next 3 Micro Tasks
24+
1.
25+
2.
26+
3.
27+
28+
## Blockers / Risks
29+
-
30+
31+
## Technical Notes
32+
- Important architectural decisions
33+
- Trade-offs
34+
- Open questions
35+
36+
## Deployment Notes
37+
- How to deploy
38+
- Environment requirements
39+
40+
## Exit Criteria for This Phase
41+
What triggers moving this project to:
42+
- Paused
43+
- Archived
44+
- Production release

0 commit comments

Comments
 (0)