Skip to content

Commit 2474570

Browse files
committed
docs: add CONTRIBUTING.md
1 parent c04dc4d commit 2474570

1 file changed

Lines changed: 56 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Contributing to AgentClick
2+
3+
Thank you for your interest in contributing!
4+
5+
## Getting Started
6+
7+
```bash
8+
git clone https://github.com/agentlayer-io/AgentClick.git
9+
cd AgentClick
10+
npm install
11+
npm run dev
12+
```
13+
14+
- Server runs at `http://localhost:38173`
15+
- Web UI runs at `http://localhost:5173`
16+
17+
## How to Contribute
18+
19+
1. Fork the repository
20+
2. Create a branch: `git checkout -b feat/your-feature`
21+
3. Make your changes
22+
4. Test locally with `npm run dev`
23+
5. Build to verify: `npm run build`
24+
6. Submit a pull request
25+
26+
## Commit Style
27+
28+
Keep commits atomic — one thing per commit. Use a short prefix:
29+
30+
- `feat:` new feature
31+
- `fix:` bug fix
32+
- `docs:` documentation only
33+
- `chore:` maintenance (deps, build, version bumps)
34+
35+
## Project Structure
36+
37+
```
38+
packages/
39+
server/ Express API server (TypeScript)
40+
web/ React + Vite frontend (TypeScript + Tailwind)
41+
skills/
42+
clickui-approve/ Action approval skill
43+
clickui-code/ Code review skill
44+
clickui-email/ Email live session skill
45+
clickui-plan/ Plan review skill
46+
clickui-trajectory/ Trajectory review skill
47+
clickui-memory/ Memory review skill
48+
```
49+
50+
## Skill Development
51+
52+
Each skill lives in `skills/<name>/SKILL.md`. If you add or modify a skill, make sure it works for both local (Claude Code, Codex) and Docker (OpenClaw) environments. See existing skills for the polling pattern.
53+
54+
## Reporting Issues
55+
56+
Open an issue at [github.com/agentlayer-io/AgentClick/issues](https://github.com/agentlayer-io/AgentClick/issues) with steps to reproduce and your environment details.

0 commit comments

Comments
 (0)