Skip to content

Commit 605f464

Browse files
committed
docs: add CONTRIBUTING.md
1 parent e94f242 commit 605f464

1 file changed

Lines changed: 42 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Contributing
2+
3+
Thanks for your interest in contributing!
4+
5+
## Development setup
6+
7+
```bash
8+
git clone <this repo>
9+
cd <repo>
10+
bundle install # Ruby projects
11+
# or
12+
npm ci # JS projects
13+
```
14+
15+
## Workflow
16+
17+
1. Fork → branch from `main`
18+
2. Make changes with tests
19+
3. Run `bundle exec rspec` (Ruby) or `npm test` (JS) locally
20+
4. Run `bundle exec standardrb` (Ruby) or `npm run lint` (JS)
21+
5. Open a PR with a clear description
22+
23+
## Code style
24+
25+
- Ruby: enforced by [StandardRB](https://github.com/standardrb/standard)
26+
- JavaScript: enforced by ESLint + Prettier
27+
- Python: enforced by ruff
28+
29+
## Commit messages
30+
31+
Use [Conventional Commits](https://www.conventionalcommits.org/):
32+
33+
```
34+
feat: add new transliteration system
35+
fix: correct off-by-one in CALT lookup
36+
chore: bump dependencies
37+
docs: clarify README
38+
```
39+
40+
## Releases
41+
42+
Maintainers tag releases following semver. CI publishes on tag push.

0 commit comments

Comments
 (0)