Skip to content

Commit a0430dc

Browse files
dj4oCdj4oC
authored
docs(ospo): community health rollout v2 — README, agents.md, health files (#248)
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>
1 parent 1f86a6e commit a0430dc

6 files changed

Lines changed: 184 additions & 23 deletions

File tree

‎CODE_OF_CONDUCT.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Code of Conduct
2+
3+
This project follows the ownCloud Code of Conduct.
4+
5+
Please read the full Code of Conduct at:
6+
**<https://owncloud.com/contribute/code-of-conduct/>**
7+
8+
By participating in this project, you agree to abide by its terms.

‎CONTRIBUTING.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Contributing
2+
3+
Thank you for your interest in contributing to this project!
4+
5+
Please read the full contributing guidelines at:
6+
**<https://owncloud.com/contribute/>**
7+
8+
For development setup, coding standards, and pull request process,
9+
see the README in this repository.

‎README.md‎

Lines changed: 78 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,95 @@
1-
# Android App Documentation
1+
# ownCloud Android App Documentation
22

3-
**IMPORTANT**
3+
<!-- OSPO-managed README | Generated: 2026-04-16 | v2 -->
44

5-
Since April 2026, this repository requires [Commit Signing](https://docs.github.com/articles/about-gpg) and uses [Conventional Commits](https://www.conventionalcommits.org) for commits and the Pull Request title.
5+
[![License](https://img.shields.io/badge/License-See%20Repository-blue.svg)](LICENSE) [![ownCloud OSPO](https://img.shields.io/badge/OSPO-ownCloud-blue)](https://kiteworks.com/opensource)
66

7-
**Table of Contents**
7+
Antora-based documentation component for the ownCloud Android mobile app. This repository contains the AsciiDoc source files for the Android client user and administration documentation, which is built as part of the [main docs site](https://github.com/owncloud/docs) and published to [doc.owncloud.com](https://doc.owncloud.com).
88

9-
* [Building the Andriod Docs](#building-the-android-docs)
10-
* [General Notes](#general-notes)
11-
* [Generating the Documentation](#generating-the-documentation)
12-
* [Target Branch and Backporting](#target-branch-and-backporting)
13-
* [Branching Workflow](#branching-workflow)
14-
* [Create a New Version Branch for the Android App](#create-a-new-version-branch-for-the-android-app)
9+
## Getting Started
1510

16-
## Building the Android Docs
11+
To preview changes locally:
1712

18-
The Android app documentation is not built independently. Instead, it is built together with the [main documentation](https://github.com/owncloud/docs/). However, you can build a local copy of the Android documentation to preview changes you are making.
13+
```bash
14+
npm install
15+
npm run antora-local
16+
npm run serve
17+
```
1918

20-
Whenever a Pull Request of this repo gets merged, it automatically triggers a full docs build.
19+
This generates a standalone preview at `http://localhost:8080`. For the full site build, merge your changes and the [docs](https://github.com/owncloud/docs) repository will automatically rebuild.
2120

22-
## General Notes
21+
## Documentation
2322

24-
To make life easier, most of the content written in [docs](https://github.com/owncloud/docs#readme) applies also here. For ease of reading, the most important steps are documented here too. For more information see the link provided. Only a few topics of this repo are unique like the branching.
23+
- [Branching Workflow](./docs/the-branching-workflow.md)
24+
- [Version Branch Creation](./docs/new-version-branch.md)
25+
- [Main Documentation Build](https://github.com/owncloud/docs)
2526

26-
## Generating the Documentation
27+
## Part of ownCloud Documentation
2728

28-
See the [Generating the Documentation](https://github.com/owncloud/docs#generating-the-documentation) in the docs repo for more details as it applies to all documentation repositories.
29+
This is a content component for the [ownCloud docs](https://github.com/owncloud/docs) Antora build. The Android client source code lives at [owncloud/android](https://github.com/owncloud/android). Published documentation is available at [doc.owncloud.com](https://doc.owncloud.com).
2930

30-
## Target Branch and Backporting
31+
## Community & Support
3132

32-
See the the [following section](https://github.com/owncloud/docs#target-branch-and-backporting) as the same rules and notes apply.
33+
**[Star](https://github.com/owncloud/docs-client-android)** this repo and **Watch** for release notifications!
3334

34-
## Branching Workflow
35+
- [ownCloud Website](https://owncloud.com)
36+
- [Community Discussions](https://github.com/orgs/owncloud/discussions)
37+
- [Matrix Chat](https://app.element.io/#/room/#owncloud:matrix.org)
38+
- [Documentation](https://doc.owncloud.com)
39+
- [Enterprise Support](https://owncloud.com/contact-us/)
40+
- [OSPO Home](https://kiteworks.com/opensource)
3541

36-
Please refer to the [Branching Workflow for the Android app](./docs/the-branching-workflow.md) for more information.
42+
## Contributing
3743

38-
## Create a New Version Branch for the Android App
44+
We welcome contributions! Please read the [Contributing Guidelines](CONTRIBUTING.md)
45+
and our [Code of Conduct](CODE_OF_CONDUCT.md) before getting started.
3946

40-
Please refer to [Create a New Version Branch for the Android App](./docs/new-version-branch.md) for more information.
47+
### Workflow
48+
49+
- **Rebase Early, Rebase Often!** We use a rebase workflow. Always rebase on the target branch before submitting a PR.
50+
- **Dependabot**: Automated dependency updates are managed via Dependabot. Review and merge dependency PRs promptly.
51+
- **Signed Commits**: All commits **must** be PGP/GPG signed. See [GitHub's signing guide](https://docs.github.com/en/authentication/managing-commit-signature-verification).
52+
- **DCO Sign-off**: Every commit must carry a `Signed-off-by` line:
53+
```
54+
git commit -s -S -m "your commit message"
55+
```
56+
- **GitHub Actions Policy**: Workflows may only use actions that are (a) owned by `owncloud`, (b) created by GitHub (`actions/*`), or (c) verified in the GitHub Marketplace.
57+
58+
## Security
59+
60+
**Do not open a public GitHub issue for security vulnerabilities.**
61+
62+
Report vulnerabilities at **<https://security.owncloud.com>** -- see [SECURITY.md](SECURITY.md).
63+
64+
Bug bounty: [YesWeHack ownCloud Program](https://yeswehack.com/programs/owncloud-bug-bounty-program)
65+
66+
## License
67+
68+
See [LICENSE](LICENSE) for license details.
69+
70+
## About the ownCloud OSPO
71+
72+
The [Kiteworks Open Source Program Office](https://kiteworks.com/opensource), operating under
73+
the [ownCloud](https://owncloud.com) brand, launched on May 5, 2026, to steward the open source
74+
ecosystem around ownCloud's products. The OSPO ensures transparent governance, license compliance,
75+
community health, and sustainable collaboration between the open source community and
76+
[Kiteworks](https://www.kiteworks.com), which acquired ownCloud in 2023.
77+
78+
- **OSPO Home**: <https://kiteworks.com/opensource>
79+
- **GitHub**: <https://github.com/owncloud>
80+
- **ownCloud**: <https://owncloud.com>
81+
82+
For questions about the OSPO or licensing, contact ospo@kiteworks.com.
83+
84+
### License Migration to Apache 2.0
85+
86+
The OSPO is driving a strategic relicensing of ownCloud repositories toward the
87+
[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0), following
88+
the [Apache Software Foundation's third-party license policy](https://www.apache.org/legal/resolved.html).
89+
90+
Individual repositories will migrate as their audit is completed. The LICENSE file
91+
in each repo reflects its **current** license status (not the target).
92+
93+
**Current license: Not detected.** The OSPO will determine the current license status of this
94+
repository before planning any migration steps. If you know the intended license, please open an
95+
issue or contact ospo@kiteworks.com.

‎SECURITY.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
**Do NOT open a public GitHub issue for security vulnerabilities.**
6+
7+
Please report security issues responsibly via:
8+
**<https://security.owncloud.com>**
9+
10+
You can also report vulnerabilities through our YesWeHack bug bounty program:
11+
**<https://yeswehack.com/programs/owncloud-bug-bounty-program>**

‎SUPPORT.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Support
2+
3+
For support with this project, please use the following channels:
4+
5+
- **Enterprise Support**: <https://owncloud.com/contact-us/>
6+
- **Community discussions**: https://github.com/orgs/owncloud/discussions
7+
- **Matrix Chat**: <https://app.element.io/#/room/#owncloud:matrix.org>
8+
- **Documentation**: <https://doc.owncloud.com>
9+
10+
Please do not use GitHub issues for general support questions.

‎agents.md‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# AI Agent Guidelines for ownCloud Android App Documentation
2+
3+
This file provides context for AI coding agents (Claude Code, GitHub Copilot, Cursor, etc.) working in this repository.
4+
5+
## Repository Overview
6+
- **Product family:** Documentation
7+
- **Primary language(s):** JavaScript
8+
- **Build system:** npm (Antora)
9+
- **Test framework:** broken-link-checker
10+
- **CI system:** GitHub Actions
11+
12+
## Architecture & Key Paths
13+
14+
- `antora.yml` -- Antora component descriptor
15+
- `modules/` -- AsciiDoc documentation content modules
16+
- `site.yml` -- Standalone site playbook for local preview
17+
- `package.json` -- npm scripts
18+
- `docs/` -- Documentation about branching and versioning
19+
- `ext-antora/` -- Custom Antora extensions
20+
- `ext-asciidoc/` -- Custom AsciiDoc extensions
21+
22+
## Development Conventions
23+
- **Branching:** master
24+
- **Commit messages:** DCO sign-off required (`git commit -s`)
25+
- **Code style:** Prettier (for formatting)
26+
- **PR process:** Open a PR against `master`. All CI checks must pass.
27+
28+
## Build & Test Commands
29+
```bash
30+
# Build
31+
npm run antora
32+
33+
# Test
34+
npm run linkcheck
35+
36+
# Lint
37+
Not detected (Prettier config present for formatting)
38+
```
39+
40+
## Important Constraints
41+
- All code contributions must be compatible with the **the license specified in the repository** license
42+
- Do not introduce new **copyleft-licensed dependencies** (GPL, AGPL, LGPL, MPL) without explicit discussion in an issue first. This is especially important for repos migrating to Apache 2.0.
43+
- Do not introduce new dependencies without discussion in an issue first
44+
45+
46+
## OSPO Policy Constraints
47+
48+
### GitHub Actions
49+
- **Only** use actions owned by `owncloud`, created by GitHub (`actions/*`), verified on the GitHub Marketplace, or verified by the ownCloud Maintainers.
50+
- Pin all actions to their full commit SHA (not tags): `uses: actions/checkout@<SHA> # vX.Y.Z`
51+
- Never introduce actions from unverified third parties.
52+
53+
### Dependency Management
54+
- Dependabot is configured for automated dependency updates.
55+
- Review and merge Dependabot PRs as part of regular maintenance.
56+
- Do not introduce new dependencies without discussion in an issue first.
57+
58+
### Git Workflow
59+
- **Rebase policy**: Always rebase; never create merge commits. Use `git pull --rebase` and `git rebase` before pushing.
60+
- **Signed commits**: All commits **must** be PGP/GPG signed (`git commit -S -s`).
61+
- **DCO sign-off**: Every commit needs a `Signed-off-by` line (`git commit -s`).
62+
- **Conventional Commits & Squash Merge**: Use the [Conventional Commits](https://www.conventionalcommits.org/) format where the repository enforces it. Many repos use squash merge, where the PR title becomes the commit message on the default branch — apply Conventional Commits format to PR titles as well. A reusable GitHub Actions workflow enforces this.
63+
64+
## Context for AI Agents
65+
- Match existing code style
66+
- Do not refactor unrelated code in the same PR
67+
- Write tests for new functionality
68+
- Keep PRs focused and atomic

0 commit comments

Comments
 (0)