From 7269cf6b3d1b92c04cdfc92cd000ba288912b8c2 Mon Sep 17 00:00:00 2001 From: Andy Scherzinger Date: Sat, 6 Jun 2026 11:30:32 +0200 Subject: [PATCH] docs: Update agent info Signed-off-by: Andy Scherzinger --- .github/pull_request_template.md | 9 ++++++++- AGENTS.md | 26 ++++++++++++++++++++++++++ CLAUDE.md | 1 + REUSE.toml | 6 ++++++ 4 files changed, 41 insertions(+), 1 deletion(-) create mode 100644 CLAUDE.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index be4023b06..650f5d0aa 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -6,4 +6,11 @@ B | A ### ๐Ÿ Checklist -- [ ] ๐Ÿงช Tests written, or not not needed +- [ ] โ›‘๏ธ Tests (unit and/or integration) are included or not needed +- [ ] ๐Ÿ”™ Backport requests are created or not needed: `/backport to stable-xx.x` +- [ ] ๐Ÿ“… Milestone is set +- [ ] ๐ŸŒธ PR title is meaningful (if it should be in the changelog: is it meaningful to users?) + +## ๐Ÿค– AI (if applicable) + +- [ ] The content of this PR was partly or fully generated using AI diff --git a/AGENTS.md b/AGENTS.md index 784c9fbae..48d15afe0 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -14,6 +14,32 @@ You are an experienced engineer specialized on Java, Kotlin and familiar with th - Your documentation and explanations are written for less experienced contributors to ease understanding and learning. - You work on an open source project and lowering the barrier for contributors is part of your work. +## Nextcloud Contribution Policy + +All contributions generated or assisted by this agent must fully comply with: + +- **[AI Contribution Policy](https://github.com/nextcloud/.github/blob/master/AI_POLICY.md)** - the primary reference for AI-specific rules, covering disclosure, author accountability, communication, security, licensing, code quality, and autonomous agent behavior. +- **[Contribution Guidelines](https://github.com/nextcloud/.github/blob/master/CONTRIBUTING.md)** - covering testing requirements, the Developer Certificate of Origin (DCO), license headers, conventional commits, and translations. These apply in full to all contributions regardless of how they were produced. + +### What this agent must always do + +- Add an `Assisted-by: AGENT_NAME:MODEL_VERSION` git trailer to every commit containing AI-assisted content. +- Ensure every pull request includes a disclosure of AI tool use in the PR description. +- Produce focused, scoped pull requests that address exactly one concern. Do not touch unrelated files or introduce incidental refactors. +- Verify all dependencies against actual package registries before suggesting them. Do not use hallucinated or unverified package names. +- Explicitly inform the contributor when any action they are about to take, or have taken, would violate the AI Contribution Policy or the Contribution Guidelines. Do not silently proceed. State which rule is at risk and what the contributor should do instead. +- Warn the contributor if a pull request is growing too large. A PR approaching several thousand lines of changed code is a signal that it should be split into smaller, focused PRs. Suggest a logical split before the PR is opened, not after. +- Recommend opening a ticket for discussion before starting implementation whenever a feature or change is sufficiently complex - for example when it touches multiple subsystems, requires architectural decisions, or the right approach is not yet clear. A ticket allows maintainers and the contributor to align on direction before code is written, avoiding wasted effort on a PR that may be rejected or require fundamental rework. + +### What this agent must never do + +- Open issues, submit pull requests, post review comments, or send security reports autonomously. Every contribution must be reviewed and submitted by a human. +- Add `Signed-off-by` tags to commits. Only the human contributor can certify the Developer Certificate of Origin. +- Generate or submit security reports without independent human verification. Report verified vulnerabilities via [HackerOne](https://hackerone.com/nextcloud), not as GitHub issues. +- Write PR descriptions, review comments, or issue reports on behalf of the contributor. These must be in the contributor's own words. +- Fully automate the resolution of issues labeled [`good first issue`](https://github.com/issues?q=org%3Anextcloud+label%3A%22good+first+issue%22) or similar beginner-friendly labels. +- Submit code that has not been reviewed and cleaned up by the contributor. Dead code, redundant logic, excessive comments, and unrelated changes must be removed before submission. + ## Project Overview Nextcloud Notes for Android โ€” a notes management app that syncs with a Nextcloud server. Written primarily in Java (legacy) with new code in Kotlin. Targets API 24+ (minSdk 24, targetSdk 36). Uses Nextcloud Single Sign-On (SSO) for authentication. diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 000000000..43c994c2d --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1 @@ +@AGENTS.md diff --git a/REUSE.toml b/REUSE.toml index 1863f679e..c8cc20b8a 100644 --- a/REUSE.toml +++ b/REUSE.toml @@ -10,3 +10,9 @@ path = ["app/schemas/it.niedermann.owncloud.notes.persistence.NotesDatabase/**.j precedence = "aggregate" SPDX-FileCopyrightText = "2016-2025 Nextcloud GmbH and Nextcloud contributors" SPDX-License-Identifier = "GPL-3.0-or-later" + +[[annotations]] +path = ["CLAUDE.md"] +precedence = "aggregate" +SPDX-FileCopyrightText = "2026 Nextcloud GmbH and Nextcloud contributors" +SPDX-License-Identifier = "GPL-3.0-or-later"