Skip to content

Commit 25ff59a

Browse files
shreyas-lyzrclaude
andcommitted
Add LICENSE and CONTRIBUTING.md
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent b95c093 commit 25ff59a

3 files changed

Lines changed: 107 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# Contributing to GitClaw
2+
3+
Thanks for your interest in contributing to GitClaw! Here's how to get started.
4+
5+
## Getting Started
6+
7+
1. Fork the repository
8+
2. Clone your fork:
9+
```bash
10+
git clone https://github.com/<your-username>/gitclaw.git
11+
cd gitclaw
12+
```
13+
3. Install dependencies:
14+
```bash
15+
npm install
16+
```
17+
4. Build the project:
18+
```bash
19+
npm run build
20+
```
21+
5. Run tests:
22+
```bash
23+
npm test
24+
```
25+
26+
## Development Workflow
27+
28+
1. Create a feature branch from `main`:
29+
```bash
30+
git checkout -b feat/my-feature
31+
```
32+
2. Make your changes in `src/`
33+
3. Run `npm run build` to verify compilation
34+
4. Run `npm test` to ensure tests pass
35+
5. Commit your changes with a clear message
36+
6. Push and open a pull request
37+
38+
## Project Structure
39+
40+
```
41+
src/
42+
├── index.ts # CLI entry point
43+
├── sdk.ts # Core SDK (query function)
44+
├── exports.ts # Public API surface
45+
├── loader.ts # Agent config loader
46+
├── tools/ # Built-in tools (cli, read, write, memory)
47+
├── voice/ # Voice mode (OpenAI Realtime adapter)
48+
├── hooks.ts # Script-based hooks
49+
├── sdk-hooks.ts # Programmatic SDK hooks
50+
├── skills.ts # Skill expansion
51+
├── workflows.ts # Workflow metadata
52+
├── agents.ts # Sub-agent metadata
53+
├── compliance.ts # Compliance validation
54+
└── audit.ts # Audit logging
55+
```
56+
57+
## Guidelines
58+
59+
- **TypeScript** — all code is written in strict TypeScript
60+
- **ESM** — the project uses ES modules (`"type": "module"`)
61+
- **Keep it simple** — avoid over-engineering; minimal dependencies
62+
- **Test your changes** — add or update tests in `test/` when applicable
63+
- **One concern per PR** — keep pull requests focused and reviewable
64+
65+
## Commit Messages
66+
67+
Use clear, descriptive commit messages:
68+
69+
- `Add voice mode with OpenAI Realtime adapter`
70+
- `Fix memory tool path resolution on Windows`
71+
- `Update SDK query to support abort signals`
72+
73+
## Reporting Issues
74+
75+
- Search existing issues before opening a new one
76+
- Include reproduction steps, expected vs actual behavior, and your environment (Node version, OS)
77+
78+
## Code of Conduct
79+
80+
Be respectful and constructive. We're all here to build something useful together.
81+
82+
## License
83+
84+
By contributing, you agree that your contributions will be licensed under the [MIT License](./LICENSE).

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 GitClaw Contributors
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -459,8 +459,8 @@ Audit logs are written to `.gitagent/audit.jsonl` with full tool invocation trac
459459

460460
## Contributing
461461

462-
Contributions are welcome! Please open an issue or submit a pull request.
462+
Contributions are welcome! Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines.
463463

464464
## License
465465

466-
MIT
466+
This project is licensed under the [MIT License](./LICENSE).

0 commit comments

Comments
 (0)