Skip to content

docs: open CONTRIBUTING to outside contributors - #19

Merged
tieuanhquoc merged 1 commit into
masterfrom
docs/open-contributing
Oct 7, 2026
Merged

tieuanhquoc merged 1 commit into
masterfrom
docs/open-contributing

Conversation

@tieuanhquoc

Copy link
Copy Markdown
Collaborator

What & why

Make the contributing guide welcoming and accurate for people outside the project.

  • Welcome note and a Where to start section: bug/feature issue templates, good first issue / help wanted labels, and docs-only PRs need no Mac build (CI skips the macOS job).
  • Dependency rule fixed: it said "zero external Swift dependencies", but Package.swift uses Apple's swift-nio / swift-nio-ssl for TLS. It now says that, and that any other package needs an issue first.
  • How to try a build on a separate data folder (-dockz.storageRoot) without touching your own Docker data; tests go in test-runner-<area>.swift.
  • What to expect on a PR: first-time contributors wait for CI approval, review threads must be resolved, the branch must be up to date (the new Update branch button handles it), squash merge; Apache-2.0 contribution note.
  • PR template: dependency checkbox reworded, CHANGELOG checkbox added.

Repo settings changed alongside (not in this diff): Update branch button on, secret scanning + push protection on, Dependabot security updates on, master ruleset renamed to protect-master (rules unchanged).

Checklist

  • Docs only — no code, no build needed

How I verified it

Checked every claim against the repo: the CI path filter in ci.yml, Package.swift dependencies, the -dockz.storageRoot launch argument, the menu item name, the labels and the issue templates.

🤖 Generated with Claude Code

- Welcome note and "Where to start" (bug/feature templates, good first
  issue / help wanted labels, docs-only PRs need no Mac build)
- Dependency rule matches Package.swift: Apple frameworks plus Apple's
  swift-nio / swift-nio-ssl; anything else needs an issue first
- Try a build on a separate data folder; tests in test-runner-<area>.swift
- What to expect on a PR: first-time CI approval, resolved threads,
  up-to-date branch, squash merge; Apache-2.0 contribution note
- PR template: dependency and CHANGELOG checkboxes

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@tieuanhquoc
tieuanhquoc merged commit d5da514 into master Oct 7, 2026
3 checks passed
@tieuanhquoc
tieuanhquoc deleted the docs/open-contributing branch October 7, 2026 11:11
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