Add contributor guide and pull request template#164
Conversation
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
There was a problem hiding this comment.
Docs-only PR (CONTRIBUTING.md, PR template, README pointer) — no code changes. The content is otherwise clear and matches the actual CI setup (Xcode 26 / Swift 6.2, xcodegen, docbuild) except for one recurring inaccuracy: CONTRIBUTING.md and the PR template both describe a swift format lint --strict requirement backed by a .swift-format config and a CI check, but neither the config file nor a swift-format CI job exists in this repo (.github/workflows/test.yml only runs package tests, example build, and docbuild). This will mislead contributors into thinking there's a formatting gate that isn't actually enforced. Please either add the .swift-format config and a CI job, or update the docs/template to stop claiming this check exists.
Add a CONTRIBUTING.md documenting the toolchain, how to build and run the package and the generated example app, the swift-format lint/format workflow, the DocC build, and the changelog and pull-request conventions. Add a PULL_REQUEST_TEMPLATE.md whose checklist mirrors what CI enforces, and link the guide from the README's Contributing section.
There was a problem hiding this comment.
Docs-only PR (CONTRIBUTING.md, PR template, README pointer). Verified the previously-flagged inaccuracy is resolved: .swift-format now exists and .github/workflows/test.yml has a swift-format lint/format-check job (landed via #163, merged into main and rebased in). All other claims in CONTRIBUTING.md (project layout, Swift Testing usage, xcodebuild commands, docbuild flags, CHANGELOG conventions) match the current repo state. No bugs or issues found.
1 participant
Summary
Lowers the barrier to a first contribution by documenting the workflow that until now lived only in scattered README lines and CI files.
CONTRIBUTING.md: requirements, project layout, how to build and test the package, how to generate and run the example app (XcodeGen), theswift formatlint/format commands, the DocC build (--warnings-as-errors), and the changelog + pull-request conventions..github/PULL_REQUEST_TEMPLATE.md: a short checklist that mirrors what CI enforces (tests, formatter-clean, DocC for public API changes, changelog for user-facing changes).Notes
swift formatsection describes the tooling introduced in Adopt swift-format for linting and formatting #163; that PR should merge first so the referenced.swift-formatconfig is present onmain.iPhone 16as an illustrative device name (any installed simulator works).