Skip to content

Add CONTRIBUTING.md - #248

Open
jatinkrmalik wants to merge 2 commits into
mainfrom
jatin/contributing
Open

Add CONTRIBUTING.md#248
jatinkrmalik wants to merge 2 commits into
mainfrom
jatin/contributing

Conversation

@jatinkrmalik

Copy link
Copy Markdown
Member

Adds a short contributor guide. On-device after model download, Apple Silicon and macOS 14+, make test/build, PRs against main, Discord, AGPL-3.0. The README points at it.

Draft until CI is green.

@netlify

netlify Bot commented Sep 3, 2026

Copy link
Copy Markdown

Deploy Preview for voca-mac failed.

Name Link
🔨 Latest commit d1776ac
🔍 Latest deploy log https://app.netlify.com/projects/voca-mac/deploys/6a9cb4d15367a000088213dd

@github-actions github-actions Bot added ci docs documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation ci labels Sep 3, 2026
@jatinkrmalik
jatinkrmalik marked this pull request as ready for review September 6, 2026 00:29
@greptile-apps

greptile-apps Bot commented Sep 6, 2026

Copy link
Copy Markdown

Greptile Summary

Adds a contributor guide and links it from the README.

  • Documents supported development hardware, macOS, and Xcode requirements.
  • Clarifies test, build, run, install, pull-request, community, and licensing workflows.

Confidence Score: 5/5

The PR appears safe to merge.

The previously reported toolchain ambiguity is resolved by explicitly requiring Xcode for app builds and limiting standalone Swift support to some unit tests, so no blocking failure remains.

Important Files Changed

Filename Overview
CONTRIBUTING.md Adds contributor guidance and now explicitly clarifies that standalone Swift supports only some tests, while building the app requires Xcode.
README.md Adds a direct link to the new contributor guide.

Reviews (2): Last reviewed commit: "Require Xcode in CONTRIBUTING setup" | Re-trigger Greptile

Comment thread CONTRIBUTING.md Outdated
make build and install call xcodebuild. A Swift-only install cannot produce VocaMac.app.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant