diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 000000000..ce144bf1f --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,8 @@ +# Code of Conduct + +This project follows the ownCloud Code of Conduct. + +Please read the full Code of Conduct at: +**** + +By participating in this project, you agree to abide by its terms. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..65c99156d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,9 @@ +# Contributing + +Thank you for your interest in contributing to this project! + +Please read the full contributing guidelines at: +**** + +For development setup, coding standards, and pull request process, +see the README in this repository. diff --git a/README.md b/README.md index d469523c1..90541c2bb 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,101 @@ # ownCloud Calendar -[![Build Status](https://drone.owncloud.com/api/badges/owncloud/calendar/status.svg)](https://drone.owncloud.com/owncloud/calendar) -[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=owncloud_calendar&metric=alert_status)](https://sonarcloud.io/dashboard?id=owncloud_calendar) -[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=owncloud_calendar&metric=security_rating)](https://sonarcloud.io/dashboard?id=owncloud_calendar) -[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=owncloud_calendar&metric=coverage)](https://sonarcloud.io/dashboard?id=owncloud_calendar) + -**A calendar app for [ownCloud](https://owncloud.org)** +[![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) -This is the new calendar app that has replaced the [old calendar app](https://github.com/owncloudarchive/calendar), and is only the frontend for the new server-integrated CalDAV-Backend. +The ownCloud Calendar app provides a web-based calendar interface for ownCloud Server. It is the frontend for the server-integrated CalDAV backend, replacing the original calendar app. Users can create and manage multiple calendars, schedule events, and share calendars with other users. The app supports Chrome/Chromium 49+, Edge 14+, Firefox 45+, Internet Explorer 11, and Safari 10+. -![](https://github.com/owncloud/screenshots/blob/master/calendar/screenshot.png) +## Part of Classic (OC10) -## Maintainer: +Calendar is an app for [ownCloud Server (Classic)](https://github.com/owncloud/core). It uses the CalDAV backend built into ownCloud Server core. The app is available on [Docker Hub as part of the ownCloud Server image](https://hub.docker.com/r/owncloud/server). - - [Julian Müller](https://github.com/Julian1998) +## Getting Started -## Contributors: +1. Clone this repository into the `apps/` directory of your ownCloud Server installation +2. Run `make` to build the app +3. Enable the app: `occ app:enable calendar` - - [Georg Ehrke](https://github.com/georgehrke) - - [Raghu Nayyar](https://github.com/raghunayyar) - - [Bernhard Fröhler](https://github.com/codeling) - - [and many more](https://github.com/owncloud/calendar/graphs/contributors) +## Documentation -If you’d like to join, just go through the [issue list](https://github.com/owncloud/calendar/issues) and fix some. :) -We’re also in [#owncloud-calendar on freenode IRC](https://webchat.freenode.net/?channels=owncloud-calendar). +- [Calendar FAQ](https://github.com/owncloud/calendar/wiki/FAQs) +- [ownCloud Server documentation](https://doc.owncloud.com) +- For CalDAV backend issues, see [ownCloud Core](https://github.com/owncloud/core) -## Support: +## Community & Support -Check out our [FAQ](https://github.com/owncloud/calendar/wiki/FAQs). If you don't find a solution, you are welcome to [ask for support](https://owncloud.org/support/) in our Forums or the IRC-Channel. If you have found a bug, feel free to open a new Issue on GitHub. Keep in mind, that this repository only manages the frontend. If you find bugs or have problems with the CalDAV-Backend, you should ask the guys at [ownCloud Core](https://github.com/owncloud/core) for help! +**[Star](https://github.com/owncloud/calendar)** this repo and **Watch** for release notifications! -## Supported Browsers +- [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) -* Chrome/Chromium 49+ -* Edge 14+ -* Firefox 45+ -* Internet Explorer 11 -* Safari 10+ +## Contributing -We don't support Internet Explorer 10 and below. Patches for IE9+ are accepted though. +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: +**** + +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 **** -- 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**: +- **GitHub**: +- **ownCloud**: + +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 diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 000000000..78094ae4c --- /dev/null +++ b/SECURITY.md @@ -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: +**** + +You can also report vulnerabilities through our YesWeHack bug bounty program: +**** diff --git a/SUPPORT.md b/SUPPORT.md new file mode 100644 index 000000000..d87c0ca86 --- /dev/null +++ b/SUPPORT.md @@ -0,0 +1,10 @@ +# Support + +For support with this project, please use the following channels: + +- **Enterprise Support**: +- **Community discussions**: https://github.com/orgs/owncloud/discussions +- **Matrix Chat**: +- **Documentation**: + +Please do not use GitHub issues for general support questions. diff --git a/agents.md b/agents.md new file mode 100644 index 000000000..a02f0ac8e --- /dev/null +++ b/agents.md @@ -0,0 +1,86 @@ +# AI Agent Guidelines for Calendar + +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, Gulp +- **Test framework:** PHPUnit, Karma (JavaScript) +- **CI system:** GitHub Actions + +## Architecture & Key Paths +- `controller/` - PHP controllers +- `http/` - HTTP layer +- `js/` - Frontend JavaScript +- `css/` - Stylesheets +- `templates/` - Server-side templates +- `l10n/` - Translations +- `appinfo/` - ownCloud app metadata +- `img/` - App icons +- `screenshots/` - App screenshots +- `tests/` - Test suites +- `Makefile` - Build and test automation +- `composer.json` - PHP dependencies +- `package.json` - JavaScript dependencies +- `gulpfile.js` - Gulp task runner configuration +- `phpunit.xml` - PHPUnit configuration + +## Development Conventions +- **Branching:** master +- **Commit messages:** DCO sign-off required (`git commit -s`) +- **Code style:** PHP_CodeSniffer, ownCloud coding standard, ESLint +- **PR process:** Open a PR against master. All CI checks must pass. + +## Build & Test Commands +```bash +# Build +make + +# Test (all) +make test + +# Test (PHP unit) +make test-php-unit + +# Test (JavaScript) +make test-js + +# Lint (PHP) +make test-php-style + +# Fix code style +make test-php-style-fix +``` + +## 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 is the frontend only; the CalDAV backend is in ownCloud Core + + +## OSPO Policy Constraints + +### GitHub Actions +- **Only** use actions owned by `owncloud`, created by GitHub (`actions/*`), or verified on the GitHub Marketplace. +- Pin all actions to their full commit SHA (not tags): `uses: actions/checkout@ # 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**: Use the [Conventional Commits](https://www.conventionalcommits.org/) format where the repository enforces it. + +## 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 +- Backend (CalDAV) issues should be filed against ownCloud Core, not this repository