Merge pull request #8413 from nextcloud/Rello-patch-2

Agent instructions on translations
This commit is contained in:
Matthieu Gallien 2025-06-30 11:50:14 +02:00 committed by GitHub
commit fcbcd1a73b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -2,21 +2,28 @@
- SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
- SPDX-License-Identifier: GPL-2.0-or-later
-->
# Project Agents.md Guide for OpenAI Codex and other AI agents
# Agents.md
This `AGENTS.md` file provides guidelines for OpenAI Codex and other AI agents interacting with this codebase, including which directories are safe to read from or write to.
## Project Overview
The Nextcloud Desktop Client is a tool to synchronize files from Nextcloud Server with your computer.
## Project Structure: AI Agent Handling Guidelines
| Directory | Description | Agent Action |
|-----------------|-----------------------------------------------------|----------------------|
| `/translations` | Translation files from Transifex. | Do not modify |
## General Guidance
All commits and PRs need to follow the Conventional Commits specification.
Every new file needs to get a SPDX header in the first rows according to this template.
The year needs to be adjusted accordingly. The commenting signs need to be used depending on the file type.
```
SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
SPDX-License-Identifier: GPL-2.0-or-later
```
Every new file needs to get a SPDX header according to this template.
The year needs to be adjusted accordingly. The commenting signs need to be ajusted depending on the file type
```
/*
* SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: GPL-2.0-or-later
*/
```
## Commit & PR Guidelines
- **Commits**: Follow Conventional Commits format. Use `feat: ...`, `fix: ...`, or `refactor: ...` as appropriate in the commit message prefix.
- Include a short summary of what changed. *Example:* `fix: prevent crash on empty todo title`.
- **Pull Request**: When the agent creates a PR, it should include a description summarizing the changes and why they were made. If a GitHub issue exists, reference it (e.g., “Closes #123”).