Skip to content

Commit f294d11

Browse files
committed
add contributing.md and update docs
1 parent 6b8c070 commit f294d11

File tree

2 files changed

+49
-1
lines changed

2 files changed

+49
-1
lines changed

CONTRIBUTING.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Contributing to Rules CLI
2+
3+
## Development Setup
4+
5+
### Prerequisites
6+
7+
- Go 1.24.2+
8+
- Node.js 12+ (for packaging)
9+
10+
### Local Development
11+
12+
```bash
13+
# Clone the repository
14+
git clone https://github.com/continuedev/rules.git
15+
cd rules
16+
17+
# Install dependencies
18+
go mod download
19+
20+
# Build the CLI
21+
go build
22+
23+
# Test your changes
24+
go test ./...
25+
```
26+
27+
## Making Changes
28+
29+
1. **Fork the repository** and create a feature branch
30+
2. **Make your changes** following these guidelines:
31+
- Keep commits focused and atomic
32+
- Add tests for new functionality
33+
- Update documentation if needed
34+
3. **Test your changes** locally
35+
4. **Include a clear description** in your pull request
36+
37+
## Release Process
38+
39+
Releases are automated via semantic-release. Use conventional commit messages:
40+
41+
- `fix:` for bug fixes
42+
- `feat:` for new features
43+
- `docs:` for documentation changes
44+
- `BREAKING CHANGE:` for breaking changes
45+
46+
## Questions?
47+
48+
Open an issue for bugs, feature requests, or questions.

docs-main/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,4 +78,4 @@ If you are building a developer tool and want to optimize how AI IDEs work with
7878

7979
### Contributing
8080

81-
`rules` will be released as open source very soon! In the meantime, you can help by sharing feedback and rules!
81+
[`rules` is open-sourced](https://github.com/continuedev/rules) under the Apache 2.0 license. If you're interested in contributing, learn more [here](https://github.com/continuedev/rules/blob/main/CONTRIBUTING.md).

0 commit comments

Comments
 (0)