-
-
Notifications
You must be signed in to change notification settings - Fork 15
Add CONTRIBUTING.md #248
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
jatinkrmalik
wants to merge
2
commits into
main
Choose a base branch
from
jatin/contributing
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+59
−0
Open
Add CONTRIBUTING.md #248
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| # Contributing | ||
|
|
||
| Thanks for helping with VocaMac. Keep dictation on-device after the model is downloaded. Do not add a Voca cloud speech path. | ||
|
|
||
| VocaMac is Beta, Apple Silicon only, macOS 14+. Intel Macs are not supported. | ||
|
|
||
| Coding agents should also read [AGENTS.md](AGENTS.md). | ||
|
|
||
| ## Ways to help | ||
|
|
||
| - Bugs and ideas: [GitHub issues](https://github.com/VocaHQ/vocamac/issues) | ||
| - Docs: `README.md`, `docs/`, and the Hugo site in `web/` | ||
| - App or test fixes against `main` | ||
| - Review PRs for privacy, insertion, and Apple Silicon regressions | ||
|
|
||
| Look for `good first issue` when that label is in use. | ||
|
|
||
|
|
||
| ## Development setup | ||
|
|
||
| You need an Apple Silicon Mac on macOS 14+, plus Xcode 15+ or Swift 5.9+. | ||
|
|
||
| ```bash | ||
| git clone https://github.com/VocaHQ/vocamac.git | ||
| cd vocamac | ||
| make test | ||
| make build | ||
| make run | ||
| ``` | ||
|
|
||
| `make install` builds and copies the app to `/Applications`. `make help` lists the rest. | ||
|
|
||
|
|
||
| ## Pull requests | ||
|
|
||
| Open against main. Keep the diff focused. | ||
|
|
||
| - Add or update tests for the behavior you change. | ||
| - Update README or docs/ when install, privacy, engines, or architecture change. | ||
| - Do not weaken on-device transcription, clipboard restore, or permissions without saying so in the PR. | ||
| - App CI runs on macos-15 with Xcode 26. Website CI runs when web/ changes. | ||
|
|
||
| Maintainers can comment /build on a PR for a signed, notarized DMG. | ||
|
|
||
| ## Community | ||
|
|
||
| Discord (https://discord.gg/t6muquAJbm) is the fastest place to talk with maintainers. Follow @vocahq on X. | ||
|
|
||
| ## License | ||
|
|
||
| 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. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.