Skip to content

Commit 1f973d7

Browse files
committed
Add CONTRIBUTING.md
1 parent 0629ef1 commit 1f973d7

2 files changed

Lines changed: 57 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Contributing
2+
3+
Thanks for helping with VocaMac. Keep dictation on-device after the model is downloaded. Do not add a Voca cloud speech path.
4+
5+
VocaMac is Beta, Apple Silicon only, macOS 14+. Intel Macs are not supported.
6+
7+
Coding agents should also read [AGENTS.md](AGENTS.md).
8+
9+
## Ways to help
10+
11+
- Bugs and ideas: [GitHub issues](https://github.com/VocaHQ/vocamac/issues)
12+
- Docs: `README.md`, `docs/`, and the Hugo site in `web/`
13+
- App or test fixes against `main`
14+
- Review PRs for privacy, insertion, and Apple Silicon regressions
15+
16+
Look for `good first issue` when that label is in use.
17+
18+
19+
## Development setup
20+
21+
You need an Apple Silicon Mac on macOS 14+, plus Xcode 15+ or Swift 5.9+.
22+
23+
```bash
24+
git clone https://github.com/VocaHQ/vocamac.git
25+
cd vocamac
26+
make test
27+
make build
28+
make run
29+
```
30+
31+
`make install` builds and copies the app to `/Applications`. `make help` lists the rest.
32+
33+
34+
## Pull requests
35+
36+
Open against main. Keep the diff focused.
37+
38+
- Add or update tests for the behavior you change.
39+
- Update README or docs/ when install, privacy, engines, or architecture change.
40+
- Do not weaken on-device transcription, clipboard restore, or permissions without saying so in the PR.
41+
- App CI runs on macos-15 with Xcode 26. Website CI runs when web/ changes.
42+
43+
Maintainers can comment /build on a PR for a signed, notarized DMG.
44+
45+
## Community
46+
47+
Discord (https://discord.gg/t6muquAJbm) is the fastest place to talk with maintainers. Follow @vocahq on X.
48+
49+
## License
50+
51+
Contributions are licensed under the GNU Affero General Public License v3.0 (AGPL-3.0). Opening a pull request means your contribution may be distributed under that license.

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -594,6 +594,12 @@ Release builds of VocaMac are **Developer ID signed and notarized** by Apple. Ac
594594
595595
---
596596

597+
## Contributing
598+
599+
See [CONTRIBUTING.md](CONTRIBUTING.md).
600+
601+
---
602+
597603
## 📄 License
598604

599605
AGPL-3.0 License - see [LICENSE](LICENSE) for details.

0 commit comments

Comments
 (0)