Skip to content

docs: centralize CODE_OF_CONDUCT and CONTRIBUTING at the monorepo root#70

Merged
loks0n merged 2 commits into
mainfrom
docs/centralize-community-files
Jul 14, 2026
Merged

docs: centralize CODE_OF_CONDUCT and CONTRIBUTING at the monorepo root#70
loks0n merged 2 commits into
mainfrom
docs/centralize-community-files

Conversation

@loks0n

@loks0n loks0n commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

What

Removes per-package CODE_OF_CONDUCT.md and CONTRIBUTING.md (and therefore from the mirrors) and replaces them with a single up-to-date copy of each at the monorepo root. Net: +86 / −2,642 lines.

Why

14 packages carried their own copies — 6 divergent versions of the code of conduct and 12 divergent versions of the contributing guide. All of them described the old standalone-repo workflow ("fork the repository, push, open a PR") which the read-only mirrors no longer support, and some pointed contributors at mirror URLs or even appwrite/appwrite's code of conduct.

The central copies

  • CODE_OF_CONDUCT.md — Contributor Covenant, upgraded 2.0 → 2.1 (the old copies also had a team@appwrite.io.. typo).
  • CONTRIBUTING.md — written for the monorepo workflow: where development happens, bin/monorepo check/test/validate, --linked testing, the Vale docs lint, PR and release conventions, and the security-report channel. Since it's now an authored doc rather than boilerplate, it's no longer excluded from the Vale lint (and passes).

Link updates

All references now point at the monorepo copies, since the mirrors no longer ship the files: the [contribution guide](CONTRIBUTING.md) links in package READMEs, absolute links to mirror repos (utopia-php/{di,storage,http,messaging}/blob/.../CONTRIBUTING.md), and the adapter-guide docs in storage/messaging that referenced ../CODE_OF_CONDUCT.md.

Follow-up idea (not in this PR)

An org-level utopia-php/.github repository with default community health files would make GitHub surface the contributing guide and code of conduct on every mirror automatically, without shipping files in the splits.

🤖 Generated with Claude Code

14 packages carried their own copies — 6 divergent versions of the code
of conduct and 12 of the contributing guide, all describing the old
standalone-repo workflow (fork the package repo) that the read-only
mirrors no longer support.

Replace them with one of each at the monorepo root: the Contributor
Covenant 2.1, and a contributing guide written for the monorepo
workflow (bin/monorepo check/test/validate, linked testing, Vale).
Package docs now link to the monorepo copies, since the mirrors no
longer ship the files.

The root CONTRIBUTING.md is ours rather than boilerplate, so it is no
longer excluded from the Vale docs lint.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Jul 14, 2026

Copy link
Copy Markdown

Benchmark results

http — Swoole modes (4 cores, 200 VUs, 20s/run)

workload mode req/s p95
ok a 16307.637479/s 26.95ms
ok b 18228.101976/s 24.14ms
io a 464.401797/s 854.36ms
io b 3348.372363/s 51.49ms
cpu a 3388.685866/s 165.86ms
cpu b 3164.035619/s 81.81ms

a = HYPERLOOP_A (process), b = HYPERLOOP_B (coroutine)

Shared CI runners — treat absolute numbers as rough, compare modes within a run. Commit 113b4ef.

@greptile-apps

greptile-apps Bot commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

Removes 14 divergent per-package CODE_OF_CONDUCT.md and CONTRIBUTING.md files and replaces them with a single canonical copy of each at the monorepo root. All README links, adapter guides, and the messaging PR template are updated to use absolute monorepo URLs, and the Vale exclusion list is trimmed so the new CONTRIBUTING.md is linted.

  • CODE_OF_CONDUCT.md: Upgraded from Contributor Covenant 2.0 to 2.1; fixes the team@appwrite.io.. double-dot typo present in several old copies.
  • CONTRIBUTING.md: Rewritten for the monorepo workflow — covers bin/monorepo check/test/validate, --linked testing, Vale linting, and the security-report channel.
  • Adapter guides (packages/storage/docs/adding-new-storage-adapter.md, packages/messaging/docs/add-new-adapter.md): The old "fork utopia-php/<mirror>" setup sections are replaced with a concise monorepo-fork instruction; section 4 (raise a PR) now targets utopia-php/monorepo.

Confidence Score: 5/5

Pure documentation reorganization with no logic changes — safe to merge.

All per-package community health files are removed and every known link (READMEs, adapter guides, PR template) is updated to the monorepo-absolute URL. No relative links to the deleted files remain anywhere in the package tree, and the adapter guides' workflow steps now correctly describe the monorepo fork path end-to-end.

No files require special attention.

Important Files Changed

Filename Overview
CONTRIBUTING.md New centralized contributing guide; describes monorepo workflow, bin/monorepo tooling, and security reporting correctly.
CODE_OF_CONDUCT.md Upgraded from Contributor Covenant 2.0 to 2.1; fixes the team@appwrite.io typo present in old per-package copies.
.vale.ini Removes CONTRIBUTING from the Vale lint exclusion list so the new central CONTRIBUTING.md is linted; CODE_OF_CONDUCT remains excluded as boilerplate.
packages/storage/docs/adding-new-storage-adapter.md Section 1.1 (fork utopia-php/storage) and section 4 (push to mirror fork) both updated to reference the monorepo; links in the intro updated to absolute monorepo URLs.
packages/messaging/docs/add-new-adapter.md Same restructure as the storage adapter guide: mirrors-are-read-only note replaces the old fork-mirror steps, and section 4 points PRs at utopia-php/monorepo.
packages/messaging/.github/PULL_REQUEST_TEMPLATE.md Two links to the old utopia-php/messaging mirror CONTRIBUTING.md updated to point at the monorepo.

Reviews (2): Last reviewed commit: "docs: point adapter guides at the monore..." | Re-trigger Greptile

The storage and messaging adapter guides still told contributors to
fork the read-only mirror and push there, contradicting the central
CONTRIBUTING.md they now link to. Collapse the GitHub fork tutorial
into a short monorepo-accurate prerequisites section, fix the
raise-a-PR step, make source paths monorepo-relative, and run tests
via bin/monorepo. Also fix the ambiguous 'Fork the project' line in
the di and http READMEs, and the guide's copy-pasted 'Storage adapter
name' in the messaging doc.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@loks0n loks0n merged commit 4141925 into main Jul 14, 2026
25 checks passed
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