Skip to content

Commit afb3d66

Browse files
committed
Put all development guidelines in contributing.md and not in readme.md
1 parent b384fab commit afb3d66

File tree

4 files changed

+78
-72
lines changed

4 files changed

+78
-72
lines changed

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# mycoder
22

3+
## 0.0.13
4+
5+
### Patch Changes
6+
7+
- Put all development guidelines in contributing.md and not in readme.md
8+
39
## 0.0.12
410

511
### Patch Changes

CONTRIBUTING.md

Lines changed: 71 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,75 @@
11
# Contributing
22

3+
Key points:
4+
5+
- Run build, test, and lint before submitting changes
6+
- Use TypeScript types over interfaces
7+
- Maintain test coverage
8+
- Keep documentation updated
9+
- Use the logger system for output
10+
11+
## Development Setup
12+
13+
```bash
14+
# Clone the repository
15+
git clone https://github.com/yourusername/mycoder.git
16+
cd mycoder
17+
18+
# Install dependencies
19+
pnpm install
20+
21+
# Create .env file with your API keys
22+
cp .env.example .env
23+
# Edit .env with your API keys
24+
```
25+
26+
### Development Commands
27+
28+
- `pnpm run build` - Build the TypeScript code
29+
- `pnpm start` - Run the application
30+
- `pnpm test` - Run tests
31+
- `pnpm run lint` - Lint the code
32+
- `pnpm run format` - Format the code
33+
- `pnpm run clean` - Clean build artifacts
34+
35+
## Architecture
36+
37+
### Core Components
38+
39+
1. **Tool System**
40+
41+
- Modular tools for specific functionalities
42+
- Categories: Interaction, I/O, System, Data Management
43+
- Parallel execution capability
44+
- Type-safe definitions
45+
46+
2. **Agent System**
47+
48+
- Main agent for orchestration
49+
- Sub-agents for parallel task execution
50+
- Anthropic Claude API integration
51+
- Hierarchical logging
52+
53+
3. **Logger System**
54+
- Color-coded component output
55+
- Hierarchical indentation
56+
- Multiple log levels (info, verbose, warn, error)
57+
- Structured data logging
58+
59+
## Project Structure
60+
61+
```
62+
src/
63+
├── core/ # Core agent and executor logic
64+
├── interfaces/ # Type definitions and interfaces
65+
├── tools/ # Tool implementations
66+
│ ├── interaction/
67+
│ ├── io/
68+
│ ├── system/
69+
│ └── record/
70+
└── utils/ # Utilities including logger
71+
```
72+
373
## Coding Style
474

575
### Terse and Simple
@@ -38,4 +108,4 @@ When making changes to the code, please ensure that the documentation in these f
38108
- `README.md`
39109
- `ARCHITECTURE.md`
40110
- `CONTRIBUTING.md`
41-
- `TOOLS.md`
111+
- `TOOLS.md`

README.md

Lines changed: 0 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -120,80 +120,10 @@ These examples showcase MyCoder's ability to handle complex software development
120120
- Node.js >=18.0.0
121121
- npm or pnpm
122122

123-
## Development Setup
124-
125-
```bash
126-
# Clone the repository
127-
git clone https://github.com/yourusername/mycoder.git
128-
cd mycoder
129-
130-
# Install dependencies
131-
pnpm install
132-
133-
# Create .env file with your API keys
134-
cp .env.example .env
135-
# Edit .env with your API keys
136-
```
137-
138-
### Development Commands
139-
140-
- `pnpm run build` - Build the TypeScript code
141-
- `pnpm start` - Run the application
142-
- `pnpm test` - Run tests
143-
- `pnpm run lint` - Lint the code
144-
- `pnpm run format` - Format the code
145-
- `pnpm run clean` - Clean build artifacts
146-
147-
## Architecture
148-
149-
### Core Components
150-
151-
1. **Tool System**
152-
153-
- Modular tools for specific functionalities
154-
- Categories: Interaction, I/O, System, Data Management
155-
- Parallel execution capability
156-
- Type-safe definitions
157-
158-
2. **Agent System**
159-
160-
- Main agent for orchestration
161-
- Sub-agents for parallel task execution
162-
- Anthropic Claude API integration
163-
- Hierarchical logging
164-
165-
3. **Logger System**
166-
- Color-coded component output
167-
- Hierarchical indentation
168-
- Multiple log levels (info, verbose, warn, error)
169-
- Structured data logging
170-
171-
## Project Structure
172-
173-
```
174-
src/
175-
├── core/ # Core agent and executor logic
176-
├── interfaces/ # Type definitions and interfaces
177-
├── tools/ # Tool implementations
178-
│ ├── interaction/
179-
│ ├── io/
180-
│ ├── system/
181-
│ └── record/
182-
└── utils/ # Utilities including logger
183-
```
184-
185123
## Contributing
186124

187125
We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for our development workflow, coding guidelines, and testing procedures.
188126

189-
Key points:
190-
191-
- Use TypeScript types over interfaces
192-
- Maintain test coverage
193-
- Keep documentation updated
194-
- Use the logger system for output
195-
- Run build, test, and lint before submitting changes
196-
197127
## License
198128

199129
MIT License

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "mycoder",
33
"description": "A command line tool using agent that can do arbitrary tasks, including coding tasks",
4-
"version": "0.0.12",
4+
"version": "0.0.13",
55
"type": "module",
66
"bin": "./bin/cli.js",
77
"main": "./dist/index.js",

0 commit comments

Comments
 (0)