docs(ospo): community health rollout v2 — README, agents.md, health files#248
docs(ospo): community health rollout v2 — README, agents.md, health files#248dj4oC 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>
3aaf055 to
ebb0ad9
Compare
DeepDiver1975
left a comment
There was a problem hiding this comment.
🤖 Automated review by Claude Code review agent.
Overview
This PR applies the Kiteworks OSPO community-health template v2 to docs-client-android: a rewritten README.md plus new agents.md, CODE_OF_CONDUCT.md, CONTRIBUTING.md, SECURITY.md, and SUPPORT.md. The redirect-style health files are clean and the README is well structured. The substantive concerns are around license metadata accuracy and a couple of broken links / awkward wording introduced by the templated content.
Code quality / style
- The four redirect health files (
CODE_OF_CONDUCT.md,CONTRIBUTING.md,SECURITY.md,SUPPORT.md) are clear and consistent. Links are well-formed. - README is much more readable than the prior version and the Getting Started commands (
npm install,npm run antora-local,npm run serve) all map to real scripts inpackage.json. Good. - Minor consistency nit: most links in
SUPPORT.mduse<...>autolink syntax, butCommunity discussionsuses a bare URL. Wrap it in<>for consistency.
Specific suggestions
-
License metadata is inaccurate (highest priority). The README states
**Current license: Not detected.**andagents.mdsays contributions must be compatible with**the license specified in the repository**. However, the repo'spackage.jsondeclares"license": "AGPL-3.0". The license is detectable — the template's "not detected" fallback fired incorrectly here. Please set the README/agents.mdto reflect AGPL-3.0. -
Broken
LICENSElinks. The README License badge (](LICENSE)) and the License section (See [LICENSE](LICENSE)) both point to aLICENSEfile, but noLICENSEfile exists in the repo root (confirmed via the GitHub contents API; root has README, package.json, antora.yml, etc., but no LICENSE). These render as broken links andbroken-link-checker(the project's own linkcheck) may flag them. Either add aLICENSEfile (AGPL-3.0, matching package.json) or point the links to the canonical license source. -
Copyleft guidance vs. actual license.
agents.mdwarns against introducing "copyleft-licensed dependencies (GPL, AGPL, LGPL, MPL)" — but the repository itself is AGPL-3.0. As written this is confusing for an AGPL project (and this is a docs-only repo with no shipped code dependencies anyway). Consider tailoring or softening this clause for documentation repos. -
"the the" typo in
agents.md:compatible with the **the license specified in the repository** license— duplicated "the" and trailing "license" reads awkwardly. Suggest:compatible with the repository's license (AGPL-3.0). -
README HTML comment exposes template internals:
<!-- OSPO-managed README | Generated: 2026-04-16 | v2 -->. Harmless, but note the generation date (2026-04-16) predates the stated rollout start (May 5, 2026) mentioned in the body and About section — minor internal inconsistency.
Potential issues / risks
- Low risk overall — this is documentation/metadata only; no build or content-module changes.
- The agents.md "Build & Test Commands" reference
npm run antoraandnpm run linkcheck, both of which exist in package.json — accurate. - The
Test framework: broken-link-checkerandLint: Not detected (Prettier config present)lines are accurate (.prettierrcexists; no separate lint script). - External links (Matrix room, YesWeHack program, kiteworks.com/opensource, doc.owncloud.com, GitHub discussions) were not all live-verified here but are consistent with the standard ownCloud/Kiteworks OSPO set.
Recommendation: Address items 1 and 2 (license accuracy + broken LICENSE link) before merge, as they directly contradict the repo's actual metadata and would fail the PR's own "License referenced in README matches actual LICENSE file" test-plan checkbox. The rest are minor cleanups.
DeepDiver1975
left a comment
There was a problem hiding this comment.
🤖 Automated review by Claude Code review agent.
Overview
This PR applies the Kiteworks OSPO community-health template v2 to docs-client-android: a rewritten README.md plus new agents.md, CODE_OF_CONDUCT.md, CONTRIBUTING.md, SECURITY.md, and SUPPORT.md. The redirect-style health files are clean and the README is well structured. The substantive concerns are around license metadata accuracy and a couple of broken links / awkward wording introduced by the templated content.
Code quality / style
- The four redirect health files (
CODE_OF_CONDUCT.md,CONTRIBUTING.md,SECURITY.md,SUPPORT.md) are clear and consistent. Links are well-formed. - README is much more readable than the prior version and the Getting Started commands (
npm install,npm run antora-local,npm run serve) all map to real scripts inpackage.json. Good. - Minor consistency nit: most links in
SUPPORT.mduse<...>autolink syntax, butCommunity discussionsuses a bare URL. Wrap it in<>for consistency.
Specific suggestions
-
License metadata is inaccurate (highest priority). The README states
**Current license: Not detected.**andagents.mdsays contributions must be compatible with**the license specified in the repository**. However, the repo'spackage.jsondeclares"license": "AGPL-3.0". The license is detectable — the template's "not detected" fallback fired incorrectly here. Please set the README/agents.mdto reflect AGPL-3.0. -
Broken
LICENSElinks. The README License badge (](LICENSE)) and the License section (See [LICENSE](LICENSE)) both point to aLICENSEfile, but noLICENSEfile exists in the repo root (confirmed via the GitHub contents API; root has README, package.json, antora.yml, etc., but no LICENSE). These render as broken links andbroken-link-checker(the project's own linkcheck) may flag them. Either add aLICENSEfile (AGPL-3.0, matching package.json) or point the links to the canonical license source. -
Copyleft guidance vs. actual license.
agents.mdwarns against introducing "copyleft-licensed dependencies (GPL, AGPL, LGPL, MPL)" — but the repository itself is AGPL-3.0. As written this is confusing for an AGPL project (and this is a docs-only repo with no shipped code dependencies anyway). Consider tailoring or softening this clause for documentation repos. -
"the the" typo in
agents.md:compatible with the **the license specified in the repository** license— duplicated "the" and trailing "license" reads awkwardly. Suggest:compatible with the repository's license (AGPL-3.0). -
README HTML comment exposes template internals:
<!-- OSPO-managed README | Generated: 2026-04-16 | v2 -->. Harmless, but note the generation date (2026-04-16) predates the stated rollout start (May 5, 2026) mentioned in the body and About section — minor internal inconsistency.
Potential issues / risks
- Low risk overall — this is documentation/metadata only; no build or content-module changes.
- The agents.md "Build & Test Commands" reference
npm run antoraandnpm run linkcheck, both of which exist in package.json — accurate. - The
Test framework: broken-link-checkerandLint: Not detected (Prettier config present)lines are accurate (.prettierrcexists; no separate lint script). - External links (Matrix room, YesWeHack program, kiteworks.com/opensource, doc.owncloud.com, GitHub discussions) were not all live-verified here but are consistent with the standard ownCloud/Kiteworks OSPO set.
Recommendation: Address items 1 and 2 (license accuracy + broken LICENSE link) before merge, as they directly contradict the repo's actual metadata and would fail the PR's own "License referenced in README matches actual LICENSE file" test-plan checkbox. The rest are minor cleanups.
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