-
Notifications
You must be signed in to change notification settings - Fork 18
docs(ospo): community health rollout v2 — README, agents.md, health files #693
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # Code of Conduct | ||
|
|
||
| This project follows the ownCloud Code of Conduct. | ||
|
|
||
| Please read the full Code of Conduct at: | ||
| **<https://owncloud.com/contribute/code-of-conduct/>** | ||
|
|
||
| By participating in this project, you agree to abide by its terms. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,26 +1,9 @@ | ||
| ## Submitting issues | ||
| # Contributing | ||
|
|
||
| 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]. | ||
| Thank you for your interest in contributing to this project! | ||
|
|
||
| ### Short version | ||
| Please read the full contributing guidelines at: | ||
| **<https://owncloud.com/contribute/>** | ||
|
|
||
| * The [**issue template can be found here**][template]. Please always use the issue template when reporting issues. | ||
|
|
||
| ### Guidelines | ||
| * Please search the existing issues first, it's likely that your issue was already reported or even fixed. | ||
| - Go to one of the repositories, click "issues" and type any word in the top search/command bar. | ||
| - You can also filter by appending e. g. "state:open" to the search string. | ||
| - More info on [search syntax within github](https://help.github.com/articles/searching-issues) | ||
| * This repository ([files_antivirus](https://github.com/owncloud/files_antivirus/issues)) is *only* for issues within the ownCloud files_antivirus code. | ||
| * __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 | ||
| * Report the issue using our [template][template], it includes all the information we need to track down the issue. | ||
|
|
||
| Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues. | ||
|
|
||
| [template]: https://raw.github.com/owncloud/core/master/issue_template.md | ||
| [mailinglist]: https://mailman.owncloud.org/mailman/listinfo/owncloud | ||
| [forum]: https://forum.owncloud.org/ | ||
| [irc]: https://webchat.freenode.net/?channels=owncloud&uio=d4 | ||
|
|
||
| ### Contribute Code and translations | ||
| Please check [core's contribution guidelines](https://github.com/owncloud/core/blob/master/CONTRIBUTING.md) for further information about contributing code and translations. | ||
| For development setup, coding standards, and pull request process, | ||
| see the README in this repository. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,40 +1,117 @@ | ||
| # ownCloud custom groups support | ||
| # Custom Groups | ||
|
|
||
| This app makes it possible for users to create their own custom groups and manage their members. | ||
| It is then possible to share files or folders with these groups. | ||
| <!-- OSPO-managed README | Generated: 2026-04-16 | v2 --> | ||
|
|
||
| ## QA metrics on master branch: | ||
| [](COPYING) [](https://kiteworks.com/opensource) [](https://hub.docker.com/r/owncloud/server) | ||
|
|
||
| [](https://drone.owncloud.com/owncloud/customgroups) | ||
| [](https://sonarcloud.io/dashboard?id=owncloud_customgroups) | ||
| [](https://sonarcloud.io/dashboard?id=owncloud_customgroups) | ||
| [](https://sonarcloud.io/dashboard?id=owncloud_customgroups) | ||
| The Custom Groups app enables regular ownCloud users to create their own groups and manage group membership, without requiring administrator privileges. Once a custom group is created, it can be used as a share target for files and folders, making it easy to collaborate with ad-hoc teams. The app provides a settings page where users can create groups, add or remove members, and manage group roles. | ||
|
|
||
| ## Requirements | ||
| ## Part of Classic (OC10) | ||
|
|
||
| * ownCloud 10.0 | ||
| Custom Groups is an app for [ownCloud Server (Classic)](https://github.com/owncloud/core). It requires ownCloud 10.0 or later. The app is available on [Docker Hub as part of the ownCloud Server image](https://hub.docker.com/r/owncloud/server). | ||
|
|
||
| ## Building the app | ||
| ## Getting Started | ||
|
|
||
| * Make sure you have [Node JS](https://nodejs.org/) installed | ||
| * Run `make` and find the tarball in the "build" directory | ||
| Follow the steps below to build and install the Custom Groups app. | ||
|
|
||
| ## Install | ||
| ### Building | ||
|
|
||
| * Extract the resulting tarball in the "apps" folder in ownCloud | ||
| ```bash | ||
| make | ||
| ``` | ||
|
|
||
| ## Usage | ||
| This requires [Node.js](https://nodejs.org/) to be installed. | ||
|
|
||
| * Login as a regular user | ||
| * Go to the settings page | ||
| * Create custom group and add other users as members | ||
| * Share file/folder with said groups | ||
| ### Installation | ||
|
|
||
| ## Developing | ||
| Extract the resulting tarball in the `apps/` folder of your ownCloud Server installation. | ||
|
|
||
| * Run `make help` to get information about the different targets. | ||
| ### Usage | ||
|
|
||
| ## Authors: | ||
| 1. Log in as a regular user | ||
| 2. Go to the settings page | ||
| 3. Create a custom group and add other users as members | ||
| 4. Share files or folders with the custom group | ||
|
|
||
| [Vincent Petry](https://github.com/PVince81/) :: PVince81 at owncloud dot com | ||
| ## Documentation | ||
|
|
||
| - [ownCloud Server documentation](https://doc.owncloud.com) | ||
| - Run `make help` for information about available Makefile targets | ||
|
|
||
| ## Community & Support | ||
|
|
||
| **[Star](https://github.com/owncloud/customgroups)** this repo and **Watch** for release notifications! | ||
|
|
||
| - [ownCloud Website](https://owncloud.com) | ||
| - [Community Discussions](https://github.com/orgs/owncloud/discussions) | ||
| - [Matrix Chat](https://app.element.io/#/room/#owncloud:matrix.org) | ||
| - [Documentation](https://doc.owncloud.com) | ||
| - [Enterprise Support](https://owncloud.com/contact-us/) | ||
| - [OSPO Home](https://kiteworks.com/opensource) | ||
|
|
||
| ## Contributing | ||
|
|
||
| We welcome contributions! Please read the [Contributing Guidelines](CONTRIBUTING.md) | ||
| and our [Code of Conduct](CODE_OF_CONDUCT.md) before getting started. | ||
|
|
||
| ### Workflow | ||
|
|
||
| - **Rebase Early, Rebase Often!** We use a rebase workflow. Always rebase on the target branch before submitting a PR. | ||
| - **Dependabot**: Automated dependency updates are managed via Dependabot. Review and merge dependency PRs promptly. | ||
| - **Signed Commits**: All commits **must** be PGP/GPG signed. See [GitHub's signing guide](https://docs.github.com/en/authentication/managing-commit-signature-verification). | ||
| - **DCO Sign-off**: Every commit must carry a `Signed-off-by` line: | ||
| ``` | ||
| git commit -s -S -m "your commit message" | ||
| ``` | ||
| - **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. | ||
|
|
||
| ## Translations | ||
|
|
||
| Help translate this project on Transifex: | ||
| **<https://explore.transifex.com/owncloud-org/owncloud/>** | ||
|
|
||
| Please submit translations via Transifex -- do not open pull requests for translation changes. | ||
|
|
||
| ## Security | ||
|
|
||
| **Do not open a public GitHub issue for security vulnerabilities.** | ||
|
|
||
| Report vulnerabilities at **<https://security.owncloud.com>** -- see [SECURITY.md](SECURITY.md). | ||
|
|
||
| Bug bounty: [YesWeHack ownCloud Program](https://yeswehack.com/programs/owncloud-bug-bounty-program) | ||
|
|
||
| ## License | ||
|
|
||
| This project is licensed under the [AGPL-3.0](COPYING). | ||
|
|
||
| ## About the ownCloud OSPO | ||
|
|
||
| The [Kiteworks Open Source Program Office](https://kiteworks.com/opensource), operating under | ||
| the [ownCloud](https://owncloud.com) brand, launched on May 5, 2026, to steward the open source | ||
| ecosystem around ownCloud's products. The OSPO ensures transparent governance, license compliance, | ||
| community health, and sustainable collaboration between the open source community and | ||
| [Kiteworks](https://www.kiteworks.com), which acquired ownCloud in 2023. | ||
|
|
||
| - **OSPO Home**: <https://kiteworks.com/opensource> | ||
| - **GitHub**: <https://github.com/owncloud> | ||
| - **ownCloud**: <https://owncloud.com> | ||
|
|
||
| For questions about the OSPO or licensing, contact ospo@kiteworks.com. | ||
|
|
||
| ### License Migration to Apache 2.0 | ||
|
|
||
| The OSPO is driving a strategic relicensing of ownCloud repositories toward the | ||
| [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0), following | ||
| the [Apache Software Foundation's third-party license policy](https://www.apache.org/legal/resolved.html). | ||
|
|
||
| Individual repositories will migrate as their audit is completed. The LICENSE file | ||
| in each repo reflects its **current** license status (not the target). | ||
|
|
||
| **Current license: AGPL-3.0** (Category X per Apache policy -- cannot be included in Apache-2.0 works). | ||
|
|
||
| Migration prerequisites for this repository: | ||
|
|
||
| - **CLA/DCO coverage**: All past contributors must have signed agreements permitting relicensing | ||
| - **Copyleft dependency audit**: All AGPL/GPL dependencies must be replaced or isolated | ||
| - **KDE heritage review**: Any code with KDE-era copyrights requires legal analysis | ||
| - **Complete relicensing**: AGPL-3.0 is a strong copyleft license; migration requires full relicensing of all files, not just a header change |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| # Security Policy | ||
|
|
||
| ## Reporting a Vulnerability | ||
|
|
||
| **Do NOT open a public GitHub issue for security vulnerabilities.** | ||
|
|
||
| Please report security issues responsibly via: | ||
| **<https://security.owncloud.com>** | ||
|
|
||
| You can also report vulnerabilities through our YesWeHack bug bounty program: | ||
| **<https://yeswehack.com/programs/owncloud-bug-bounty-program>** |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| # Support | ||
|
|
||
| For support with this project, please use the following channels: | ||
|
|
||
| - **Enterprise Support**: <https://owncloud.com/contact-us/> | ||
| - **Community discussions**: https://github.com/orgs/owncloud/discussions | ||
| - **Matrix Chat**: <https://app.element.io/#/room/#owncloud:matrix.org> | ||
| - **Documentation**: <https://doc.owncloud.com> | ||
|
|
||
| Please do not use GitHub issues for general support questions. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| # AI Agent Guidelines for Custom Groups | ||
|
|
||
| This file provides context for AI coding agents (Claude Code, GitHub Copilot, Cursor, etc.) working in this repository. | ||
|
|
||
| ## Repository Overview | ||
| - **Product family:** Classic (OC10) | ||
| - **Primary language(s):** JavaScript, PHP | ||
| - **Build system:** Composer, Make, npm/Yarn | ||
| - **Test framework:** PHPUnit, Karma (JavaScript) | ||
| - **CI system:** GitHub Actions | ||
|
|
||
| ## Architecture & Key Paths | ||
| - `lib/` - PHP application logic | ||
| - `appinfo/` - ownCloud app metadata and registration | ||
| - `templates/` - Server-side templates | ||
| - `js/` - Frontend JavaScript | ||
| - `css/` - Stylesheets | ||
| - `l10n/` - Translations | ||
| - `img/` - App icons | ||
| - `rules/` - Custom rules | ||
| - `tools/` - Development tools | ||
| - `tests/` - PHP, JS and acceptance test suites | ||
| - `Makefile` - Build and test automation | ||
| - `composer.json` - PHP dependencies | ||
| - `package.json` - JavaScript dependencies | ||
| - `phpcs.xml` - PHP_CodeSniffer configuration | ||
| - `phpstan.neon` - PHPStan configuration | ||
| - `phpunit.xml` - PHPUnit configuration | ||
| - `CONTRIBUTING.md` - Contribution guidelines | ||
|
|
||
| ## Development Conventions | ||
| - **Branching:** master | ||
| - **Commit messages:** DCO sign-off required (`git commit -s`) | ||
| - **Code style:** PHP_CodeSniffer (phpcs.xml), ownCloud coding standard | ||
| - **PR process:** Open a PR against master. All CI checks must pass. | ||
|
|
||
| ## Build & Test Commands | ||
| ```bash | ||
| # Build | ||
| make | ||
|
|
||
| # Test (all) | ||
| make test | ||
|
|
||
| # Test (JavaScript) | ||
| npm test | ||
|
|
||
| # Lint (PHP) | ||
| make test-php-style | ||
|
|
||
| # Fix code style | ||
| make test-php-style-fix | ||
|
|
||
| # Static analysis | ||
| make test-php-phpstan | ||
|
|
||
| # Test (PHP unit) | ||
| make test-php-unit | ||
|
|
||
| # Test (API Acceptance) | ||
| make test-acceptance-api | ||
|
|
||
| # Show available targets | ||
| make help | ||
| ``` | ||
|
|
||
| ## Important Constraints | ||
| - All code contributions must be compatible with the **AGPL-3.0** license | ||
| - 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. | ||
| - Do not introduce new dependencies without discussion in an issue first | ||
| - This app requires ownCloud Server 10.0 or later | ||
|
|
||
|
|
||
| ## OSPO Policy Constraints | ||
|
|
||
| ### GitHub Actions | ||
| - **Only** use actions owned by `owncloud`, created by GitHub (`actions/*`), verified on the GitHub Marketplace, or verified by the ownCloud Maintainers. | ||
| - Pin all actions to their full commit SHA (not tags): `uses: actions/checkout@<SHA> # vX.Y.Z` | ||
| - Never introduce actions from unverified third parties. | ||
|
|
||
| ### Dependency Management | ||
| - Dependabot is configured for automated dependency updates. | ||
| - Review and merge Dependabot PRs as part of regular maintenance. | ||
| - Do not introduce new dependencies without discussion in an issue first. | ||
|
|
||
| ### Git Workflow | ||
| - **Rebase policy**: Always rebase; never create merge commits. Use `git pull --rebase` and `git rebase` before pushing. | ||
| - **Signed commits**: All commits **must** be PGP/GPG signed (`git commit -S -s`). | ||
| - **DCO sign-off**: Every commit needs a `Signed-off-by` line (`git commit -s`). | ||
| - **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. | ||
|
|
||
| ## Context for AI Agents | ||
| - Match existing code style | ||
| - Do not refactor unrelated code in the same PR | ||
| - Write tests for new functionality | ||
| - Keep PRs focused and atomic | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.