docs(ospo): community health rollout v2 — README, agents.md, health files#1260
docs(ospo): community health rollout v2 — README, agents.md, health files#1260dj4oC wants to merge 2 commits into
Conversation
…iles Introduced by the Kiteworks Open Source Program Office (OSPO) on May 5, 2026. Changes: - README.md: rewritten with OSPO v2 template — license-specific migration guidance, Community & Support section, Contributing workflow, Security section pointing to security.owncloud.com + YesWeHack bug bounty - agents.md: AI agent context file with architecture, build commands, and OSPO Policy Constraints (GitHub Actions, Dependabot, Git Workflow) - CODE_OF_CONDUCT.md: redirect to https://owncloud.com/contribute/code-of-conduct/ - CONTRIBUTING.md: redirect to https://owncloud.com/contribute/ - SECURITY.md: redirect to https://security.owncloud.com + YesWeHack - SUPPORT.md: redirect to https://owncloud.com/contact-us/ + channels OSPO: https://kiteworks.com/opensource Signed-off-by: David Walter <david.walter@kiteworks.com>
db64800 to
c40f0be
Compare
DeepDiver1975
left a comment
There was a problem hiding this comment.
🤖 Automated review by Claude Code review agent.
Overview
This PR is part of the Kiteworks OSPO community health rollout. It rewrites README.md with the v2 OSPO template and adds five community health files (agents.md, CODE_OF_CONDUCT.md, CONTRIBUTING.md, SECURITY.md, SUPPORT.md). The changes are documentation-only and well structured. Overall this is a solid, useful improvement: the new README is clearer than the old one, the build instructions are accurate, and the relative doc links resolve correctly.
I verified the claims against the actual repository contents. Most check out, but a few items below need attention before merge.
Code quality / style
- README structure, badges, and section ordering render correctly as GitHub Markdown.
- Build instructions are accurate:
npm install,npm run antora-local, andnpm run serveall exist inpackage.json, andantora-localdoes targethttp://localhost:8080as stated. - Relative documentation links resolve:
./docs/the-branching-workflow.mdand./docs/new-version-branch.mdboth exist. agents.mdbuild/test commands are correct:npm run antora(build) andnpm run linkcheck(test) both exist. Prettier config (.prettierrc) is present as claimed, and.github/dependabot.ymlexists, so the Dependabot references are valid.- The conditionally-worded, audit-aware license language ("Current license: Not detected", "reflects its current license status") is a sensible way to handle a templated rollout.
Specific suggestions
-
GitHub Discussions is not enabled on this repo. Both the README ("Community Discussions" →
https://github.com/orgs/owncloud/discussions) andSUPPORT.md("Community discussions") link to org-level Discussions. The repo hashas_discussions: false. The org-level link may still work if Discussions exist elsewhere in the org, but please confirm the org Discussions tab is actually populated/enabled — otherwise this is a dead-end link for users seeking support. -
README "License" section links to a nonexistent
LICENSEfile. The License section saysSee [LICENSE](LICENSE) for license details.and the badge also points toLICENSE, but there is no LICENSE file in this repository. This produces a broken link / 404 badge target. The "About the OSPO" section already acknowledges "Current license: Not detected", so the explicit[LICENSE](LICENSE)link and badge are inconsistent with that and with the repo reality. Suggest either adding a LICENSE file or softening the License section to not link to a missing file. -
agents.md"Primary language(s): JavaScript" is misleading. This is a documentation component — the substantive content is AsciiDoc undermodules/, with JavaScript only in the Antora/AsciiDoc extension helpers (ext-antora/,ext-asciidoc/,lib/). Calling the primary language JavaScript may misdirect an AI agent. Consider "AsciiDoc (content); JavaScript (Antora extensions)". -
agents.mdLint command and grammar nits:- "Lint: Not detected (Prettier config present for formatting)" — Prettier is present, so this is slightly self-contradictory; consider listing
npx prettieras the formatter. - Typo: "compatible with the the license specified in the repository license" — duplicated/garbled wording ("the the … license").
- "Lint: Not detected (Prettier config present for formatting)" — Prettier is present, so this is slightly self-contradictory; consider listing
-
Doc-accuracy nit in README "Getting Started": the
servescript serves thepublic/directory, which is produced by the fullantora/antora-localbuild. The three-command sequence is correct, but a one-line note thatservehosts the generatedpublic/output would help newcomers.
Potential issues / risks
- Broken link risk (medium): the
LICENSElink/badge with no LICENSE file is the most concrete issue — it will 404. Worth fixing since one of the PR's own test-plan items is "License referenced in README matches actual LICENSE file in repo," which currently fails (no LICENSE file exists). - Discussions link (low-medium): verify org Discussions are live before relying on them as the primary community channel.
- Metadata accuracy (low): the "Primary language: JavaScript" classification in
agents.md. - No security, secret, or config-correctness concerns — all external URLs (security.owncloud.com, YesWeHack, Matrix, Transifex, owncloud.dev) are plausible and consistently used across files. The redirect-style health files are minimal and correct.
Nice work overall — the substance is good and well-verified against the repo. Addressing the LICENSE link inconsistency and the agents.md language/typo items would tighten it up.
DeepDiver1975
left a comment
There was a problem hiding this comment.
🤖 Automated review by Claude Code review agent.
This is a re-review at the current head (4e3e2c0) after new commits were pushed. Focus is on the current state, with attention to issues flagged in the prior review.
Overview
The PR applies the v2 OSPO community-health template: a rewritten README.md plus new agents.md, CODE_OF_CONDUCT.md, CONTRIBUTING.md, SECURITY.md, and SUPPORT.md. The rewrite is well-structured and the new product description (Antora/AsciiDoc component for oCIS docs) is accurate. The redirect-style health files are clean and consistent. Most internal doc links (./docs/the-branching-workflow.md, ./docs/new-version-branch.md) resolve correctly.
Code quality / style
- README structure, badges, and section layout render well and read clearly.
- Health files (
CODE_OF_CONDUCT.md,CONTRIBUTING.md,SECURITY.md,SUPPORT.md) are consistent and point to valid external URLs. - Mixed link styles in
SUPPORT.md(barehttps://github.com/orgs/owncloud/discussionsvs.<...>autolinks elsewhere) — minor cosmetic inconsistency.
Specific suggestions
- Add a
LICENSEfile or stop linking to one (see risks). Givenpackage.jsondeclares"license": "AGPL-3.0", committing a matchingLICENSEfile would fix the broken link and the license-detection contradiction in one step. - Fix the contradicting license statements. README "Current license: Not detected" is incorrect — the license is declared in
package.jsonon this same branch. agents.mdtypo (carried over, not fixed): "All code contributions must be compatible with the the license specified in the repository license" — duplicated "the" and a redundant trailing "license".agents.md"Primary language(s): JavaScript" remains misleading. GitHub linguist does report JavaScript as the top language (AsciiDoc isn't counted as a programming language), so it is defensible by raw stats — but for a repo whose ownagents.mdlists "Product family: Documentation" and whose substance is AsciiDoc content undermodules/, listing JavaScript as the primary language misleads an AI agent about the repo's purpose. Consider "AsciiDoc (docs content); JavaScript (Antora extensions/tooling)".
Potential issues / risks
- Broken
LICENSElink — NOT fixed (test-plan item 4 still fails). Verified via the GitHub API that noLICENSEfile exists on the PR head branch (ospo/community-health-v2, HTTP 404) nor onmaster. The README links to it in three places: the License badge](LICENSE), the## Licensesection[LICENSE](LICENSE), andagents.md. These are broken links and will fail the PR's own test-plan checkbox ("License referenced in README matches actual LICENSE file in repo") and likely thebroken-link-checkerCI step. - License contradiction. README says the current license is "Not detected", but
package.jsonon this branch declares"license": "AGPL-3.0". The two should be reconciled; "Not detected" is factually wrong here. - AGPL vs. copyleft-dependency guidance.
agents.mdadvises against introducing "new copyleft-licensed dependencies (GPL, AGPL, LGPL, MPL)", yet the repository itself is AGPL-3.0. As written this reads oddly for an AGPL project; clarify the intent (presumably about target Apache-2.0 migration, not the current state). - Org GitHub Discussions — appears resolved. The previously flagged concern (org Discussions not enabled) no longer reproduces:
https://github.com/orgs/owncloud/discussionsresolves (HTTP 200) and the org profile exposes a Discussions nav link. The README/SUPPORT links to org-level discussions are therefore valid. (Note: repo-levelhas_discussionsisfalse, which is fine since the links target the org, not this repo.)
Re-check summary of prior issues
- README → nonexistent
LICENSE(broken link): still broken — not fixed. - Org GitHub Discussions not enabled: resolved (org discussions now live).
agents.md"primary language: JavaScript" misleading + duplicated-word typo: still present — not fixed (typo "the the" remains; language line unchanged).
Overall: the structural rewrite is solid, but the LICENSE link / license-detection issue is a real, CI-relevant defect and should be addressed before merge.
Summary
This PR is part of the Kiteworks OSPO community health rollout (kiteworks.com/opensource), applied to all ~110 public ownCloud repositories starting May 5, 2026.
Test plan
🤖 Generated with Claude Code as part of the ownCloud OSPO rollout.
Kiteworks OSPO: https://kiteworks.com/opensource