Skip to content

Commit 82d68e6

Browse files
authored
docs(ospo): community health rollout v2 — README, agents.md, health files (#206)
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 31a3ea7 commit 82d68e6

6 files changed

Lines changed: 205 additions & 37 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: 6 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,9 @@
1-
## Submitting issues
1+
# Contributing
22

3-
If you have questions about how to install or use ownCloud, please direct these to the [mailing list][mailinglist] or our [forum][forum]. We are also available on [IRC][irc].
3+
Thank you for your interest in contributing to this project!
44

5-
### Short version
5+
Please read the full contributing guidelines at:
6+
**<https://owncloud.com/contribute/>**
67

7-
* The [**issue template can be found here**][template]. Please always use the issue template when reporting issues.
8-
9-
### Guidelines
10-
* Please search the existing issues first, it's likely that your issue was already reported or even fixed.
11-
- Go to one of the repositories, click "issues" and type any word in the top search/command bar.
12-
- You can also filter by appending e. g. "state:open" to the search string.
13-
- More info on [search syntax within github](https://help.github.com/articles/searching-issues)
14-
* This repository ([Announcement Center](https://github.com/owncloud/announcementcenter/issues)) is *only* for issues within the ownCloud Announcement Center code.
15-
* __SECURITY__: Report any potential security bug to security@owncloud.com following our [security policy](https://owncloud.org/security/) instead of filing an issue in our bug tracker
16-
* Report the issue using our [template][template], it includes all the information we need to track down the issue.
17-
18-
Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues.
19-
20-
[template]: https://raw.github.com/owncloud/core/master/issue_template.md
21-
[mailinglist]: https://mailman.owncloud.org/mailman/listinfo/owncloud
22-
[forum]: https://forum.owncloud.org/
23-
[irc]: https://webchat.freenode.net/?channels=owncloud&uio=d4
24-
25-
### Contribute Code and translations
26-
Please check [core's contribution guidelines](https://github.com/owncloud/core/blob/master/CONTRIBUTING.md) for further information about contributing code and translations.
8+
For development setup, coding standards, and pull request process,
9+
see the README in this repository.

‎README.md‎

Lines changed: 89 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,101 @@
11
# Announcement Center
22

3-
An Announcement Center app for ownCloud (allows administrators to publish announcements for users)
4-
Depends on ['notifications'](https://github.com/owncloud/notifications) backend
3+
<!-- OSPO-managed README | Generated: 2026-04-16 | v2 -->
54

6-
## QA metrics on master branch:
5+
[![License](https://img.shields.io/badge/License-AGPL--3.0-blue.svg)](COPYING) [![ownCloud OSPO](https://img.shields.io/badge/OSPO-ownCloud-blue)](https://kiteworks.com/opensource) [![Docker Hub](https://img.shields.io/docker/pulls/owncloud)](https://hub.docker.com/r/owncloud/server)
76

8-
[![Build Status](https://drone.owncloud.com/api/badges/owncloud/announcementcenter/status.svg?branch=master)](https://drone.owncloud.com/owncloud/announcementcenter)
9-
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=owncloud_announcementcenter&metric=alert_status)](https://sonarcloud.io/dashboard?id=owncloud_announcementcenter)
10-
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=owncloud_announcementcenter&metric=security_rating)](https://sonarcloud.io/dashboard?id=owncloud_announcementcenter)
11-
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=owncloud_announcementcenter&metric=coverage)](https://sonarcloud.io/dashboard?id=owncloud_announcementcenter)
7+
The Announcement Center is an ownCloud Server app that allows administrators to publish announcements visible to all users. Announcements appear on a dedicated front page accessible from the app launcher, and users are automatically notified via the activity stream. The app depends on the [notifications](https://github.com/owncloud/notifications) backend for delivering notifications.
128

13-
---
9+
## Part of Classic (OC10)
1410

15-
## Screenshots
11+
Announcement Center is an app for [ownCloud Server (Classic)](https://github.com/owncloud/core). It is available on [Docker Hub as part of the ownCloud Server image](https://hub.docker.com/r/owncloud/server).
1612

17-
### Announcements front page (the "Add announcement" form is admin only)
13+
## Getting Started
1814

19-
![Announcement Center Frontpage](docs/AnnouncementCenterFrontpage.png)
15+
1. Clone this repository into the `apps/` directory of your ownCloud Server installation
16+
2. Run `make` to build the app
17+
3. Enable the app: `occ app:enable announcementcenter`
18+
4. Ensure the [notifications](https://github.com/owncloud/notifications) app is also installed and enabled
2019

21-
---
20+
## Documentation
2221

23-
### The users are also informed by an activity in their stream (can not be disabled)
22+
- See the `docs/` directory for screenshots and additional information
23+
- [ownCloud Server documentation](https://doc.owncloud.com)
2424

25-
![Announcement Activity](docs/AnnouncementActivity.png)
25+
## Community & Support
2626

27+
**[Star](https://github.com/owncloud/announcementcenter)** this repo and **Watch** for release notifications!
28+
29+
- [ownCloud Website](https://owncloud.com)
30+
- [Community Discussions](https://github.com/orgs/owncloud/discussions)
31+
- [Matrix Chat](https://app.element.io/#/room/#owncloud:matrix.org)
32+
- [Documentation](https://doc.owncloud.com)
33+
- [Enterprise Support](https://owncloud.com/contact-us/)
34+
- [OSPO Home](https://kiteworks.com/opensource)
35+
36+
## Contributing
37+
38+
We welcome contributions! Please read the [Contributing Guidelines](CONTRIBUTING.md)
39+
and our [Code of Conduct](CODE_OF_CONDUCT.md) before getting started.
40+
41+
### Workflow
42+
43+
- **Rebase Early, Rebase Often!** We use a rebase workflow. Always rebase on the target branch before submitting a PR.
44+
- **Dependabot**: Automated dependency updates are managed via Dependabot. Review and merge dependency PRs promptly.
45+
- **Signed Commits**: All commits **must** be PGP/GPG signed. See [GitHub's signing guide](https://docs.github.com/en/authentication/managing-commit-signature-verification).
46+
- **DCO Sign-off**: Every commit must carry a `Signed-off-by` line:
47+
```
48+
git commit -s -S -m "your commit message"
49+
```
50+
- **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.
51+
52+
## Translations
53+
54+
Help translate this project on Transifex:
55+
**<https://explore.transifex.com/owncloud-org/owncloud/>**
56+
57+
Please submit translations via Transifex -- do not open pull requests for translation changes.
58+
59+
## Security
60+
61+
**Do not open a public GitHub issue for security vulnerabilities.**
62+
63+
Report vulnerabilities at **<https://security.owncloud.com>** -- see [SECURITY.md](SECURITY.md).
64+
65+
Bug bounty: [YesWeHack ownCloud Program](https://yeswehack.com/programs/owncloud-bug-bounty-program)
66+
67+
## License
68+
69+
This project is licensed under the [AGPL-3.0](COPYING).
70+
71+
## About the ownCloud OSPO
72+
73+
The [Kiteworks Open Source Program Office](https://kiteworks.com/opensource), operating under
74+
the [ownCloud](https://owncloud.com) brand, launched on May 5, 2026, to steward the open source
75+
ecosystem around ownCloud's products. The OSPO ensures transparent governance, license compliance,
76+
community health, and sustainable collaboration between the open source community and
77+
[Kiteworks](https://www.kiteworks.com), which acquired ownCloud in 2023.
78+
79+
- **OSPO Home**: <https://kiteworks.com/opensource>
80+
- **GitHub**: <https://github.com/owncloud>
81+
- **ownCloud**: <https://owncloud.com>
82+
83+
For questions about the OSPO or licensing, contact ospo@kiteworks.com.
84+
85+
### License Migration to Apache 2.0
86+
87+
The OSPO is driving a strategic relicensing of ownCloud repositories toward the
88+
[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0), following
89+
the [Apache Software Foundation's third-party license policy](https://www.apache.org/legal/resolved.html).
90+
91+
Individual repositories will migrate as their audit is completed. The LICENSE file
92+
in each repo reflects its **current** license status (not the target).
93+
94+
**Current license: AGPL-3.0** (Category X per Apache policy -- cannot be included in Apache-2.0 works).
95+
96+
Migration prerequisites for this repository:
97+
98+
- **CLA/DCO coverage**: All past contributors must have signed agreements permitting relicensing
99+
- **Copyleft dependency audit**: All AGPL/GPL dependencies must be replaced or isolated
100+
- **KDE heritage review**: Any code with KDE-era copyrights requires legal analysis
101+
- **Complete relicensing**: AGPL-3.0 is a strong copyleft license; migration requires full relicensing of all files, not just a header change

‎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: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# AI Agent Guidelines for Announcement Center
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:** Classic (OC10)
7+
- **Primary language(s):** PHP, JavaScript
8+
- **Build system:** Composer, Make
9+
- **Test framework:** PHPUnit
10+
- **CI system:** GitHub Actions
11+
12+
## Architecture & Key Paths
13+
- `lib/` - PHP application logic
14+
- `appinfo/` - ownCloud app metadata and registration
15+
- `templates/` - Server-side templates
16+
- `js/` - Frontend JavaScript
17+
- `css/` - Stylesheets
18+
- `l10n/` - Translations
19+
- `img/` - App icons
20+
- `tests/` - PHPUnit test suite
21+
- `docs/` - Screenshots and documentation
22+
- `Makefile` - Build and test automation
23+
- `composer.json` - PHP dependencies
24+
- `phpstan.neon` - PHPStan configuration
25+
- `phpunit.xml` - PHPUnit configuration
26+
- `CONTRIBUTING.md` - Contribution guidelines
27+
28+
## Development Conventions
29+
- **Branching:** master
30+
- **Commit messages:** DCO sign-off required (`git commit -s`)
31+
- **Code style:** PHP_CodeSniffer, ownCloud coding standard
32+
- **PR process:** Open a PR against master. All CI checks must pass.
33+
34+
## Build & Test Commands
35+
```bash
36+
# Build
37+
make
38+
39+
# Test
40+
make test-php-unit
41+
42+
# Lint
43+
make test-php-style
44+
45+
# Fix code style
46+
make test-php-style-fix
47+
48+
# Static analysis
49+
make test-php-phpstan
50+
```
51+
52+
## Important Constraints
53+
- All code contributions must be compatible with the **AGPL-3.0** license
54+
- 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.
55+
- Do not introduce new dependencies without discussion in an issue first
56+
- This app depends on the `notifications` app backend
57+
58+
59+
## OSPO Policy Constraints
60+
61+
### GitHub Actions
62+
- **Only** use actions owned by `owncloud`, created by GitHub (`actions/*`), verified on the GitHub Marketplace, or verified by the ownCloud Maintainers.
63+
- Pin all actions to their full commit SHA (not tags): `uses: actions/checkout@<SHA> # vX.Y.Z`
64+
- Never introduce actions from unverified third parties.
65+
66+
### Dependency Management
67+
- Dependabot is configured for automated dependency updates.
68+
- Review and merge Dependabot PRs as part of regular maintenance.
69+
- Do not introduce new dependencies without discussion in an issue first.
70+
71+
### Git Workflow
72+
- **Rebase policy**: Always rebase; never create merge commits. Use `git pull --rebase` and `git rebase` before pushing.
73+
- **Signed commits**: All commits **must** be PGP/GPG signed (`git commit -S -s`).
74+
- **DCO sign-off**: Every commit needs a `Signed-off-by` line (`git commit -s`).
75+
- **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.
76+
77+
## Context for AI Agents
78+
- Match existing code style
79+
- Do not refactor unrelated code in the same PR
80+
- Write tests for new functionality
81+
- Keep PRs focused and atomic

0 commit comments

Comments
 (0)