This is an automated email from the ASF dual-hosted git repository.
gnodet pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new b973459da7b4 chore: clarify documentation requirements in AGENTS.md
b973459da7b4 is described below
commit b973459da7b4464b6d52c36f403353c7155f388c
Author: Guillaume Nodet <[email protected]>
AuthorDate: Wed May 20 09:49:57 2026 +0200
chore: clarify documentation requirements in AGENTS.md
* chore: clarify documentation requirements in AGENTS.md
Expand the documentation bullet in the Code Quality section to
explicitly mention the upgrade guide and component docs, so
behavioral changes are not shipped without user-facing documentation.
Co-Authored-By: Claude Opus 4.6 <[email protected]>
* chore: broaden documentation checklist in AGENTS.md
Expand the list of change types that require upgrade guide entries
to cover all categories seen in practice: API/SPI changes, removed
or deprecated components, migrated libraries, renamed doc pages.
Co-Authored-By: Claude Opus 4.6 <[email protected]>
* chore: note that backport upgrade guide entries go on main
Co-Authored-By: Claude Opus 4.6 <[email protected]>
---------
Co-authored-by: Claude Opus 4.6 <[email protected]>
---
AGENTS.md | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/AGENTS.md b/AGENTS.md
index 6810f77e3674..e003bf9b416d 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -73,6 +73,13 @@ When creating a PR, **always identify and request reviews**
from the most releva
- Every PR must include tests for new functionality or bug fixes.
- Every PR must include documentation updates where applicable.
+ Any user-visible change must be documented in the upgrade guide
+ (`docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_XX.adoc`) and
in the relevant
+ command or component documentation page. This includes: changed defaults,
new auto-detection
+ behavior, removed or renamed options, changed header names or values,
API/SPI signature changes,
+ removed or deprecated components, migrated libraries, and renamed
documentation pages.
+ For backported changes, the upgrade guide entry must be added on the `main`
branch (not on the
+ maintenance branch where the fix is backported).
- All code must pass formatting checks (`mvn formatter:format impsort:sort`)
before pushing.
- All generated files must be regenerated and committed (CI checks for
uncommitted changes).
