Skip to content

docs: add contributing, security and agent guides - #127

Merged
ykisana merged 1 commit into
mainfrom
docs/contributing
Nov 19, 2026
Merged

ykisana merged 1 commit into
mainfrom
docs/contributing

Conversation

@ykisana

@ykisana ykisana commented Nov 18, 2026

Copy link
Copy Markdown
Contributor

Adds contributor, security and agent docs.

  • .github/CONTRIBUTING.md:
    • open an issue first and wait for agreement;
    • PRs link the issue and say how they were tested;
    • AI policy: name your tools in the PR and add Co-authored-by: <agent> (<model>) there when an agent wrote code; commits are authored by your own account only (no AI as author or co-author); be able to explain the change; don't weaken tests;
    • the hard-to-reverse areas that need agreement in the issue.
  • .github/SECURITY.md: report through private vulnerability reporting (now on), what a report needs, and what's in and out of scope.
  • .github/pull_request_template.md: issue link, what and why, how it was tested, AI use, and a hard-to-reverse checkbox.
  • AGENTS.md: the build and test command, the UI test seams, the project-file membership lists, syncing the string catalog, wording, test rules, and commit and PR rules. CLAUDE.md imports it.

To confirm the catalog command, I added a probe string and ran xcodebuild -exportLocalizations. The string appeared in Localizable.xcstrings, and an unused string was removed. I reverted both.

The Co-authored-by line in a PR description stays off main, because squash merges build the commit message from the PR's commits, not its description.

Co-authored-by: Claude Code (Claude Opus 5.5)

CONTRIBUTING asks for an issue before every PR, sets the AI policy
(human-only commit authors, disclosure in the PR) and lists the
hard-to-reverse areas. SECURITY points to private vulnerability
reporting. AGENTS.md holds the build, test and project-file rules,
and CLAUDE.md imports it.
@ykisana
ykisana merged commit 9cf0704 into main Nov 19, 2026
3 checks passed
@ykisana
ykisana deleted the docs/contributing branch November 19, 2026 01:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant