You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by gn...@apache.org on 2026/07/27 13:56:33 UTC
(camel) branch investigate-and-fix-camel-24228-agents-md-do-no created (now 061d9adf0d5d)
This is an automated email from the ASF dual-hosted git repository.
gnodet pushed a change to branch investigate-and-fix-camel-24228-agents-md-do-no
in repository https://gitbox.apache.org/repos/asf/camel.git
at 061d9adf0d5d CAMEL-24228: Clarify upgrade guide is for migration only, not new features
This branch includes the following new commits:
new 061d9adf0d5d CAMEL-24228: Clarify upgrade guide is for migration only, not new features
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
(camel) 01/01: CAMEL-24228: Clarify upgrade guide is for migration only, not new features
Posted by gn...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
gnodet pushed a commit to branch investigate-and-fix-camel-24228-agents-md-do-no
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 061d9adf0d5d70b35fc5e1aebe3fa454c95567aa
Author: Guillaume Nodet <gn...@gmail.com>
AuthorDate: Mon Jul 27 15:56:18 2026 +0200
CAMEL-24228: Clarify upgrade guide is for migration only, not new features
The Code Quality section previously stated "Any user-visible change must
be documented in the upgrade guide" which incorrectly suggested new
features should be added to the upgrade guide. The upgrade guide is only
for changes that affect existing users upgrading (changed defaults,
removed/renamed options, API changes, deprecations, etc.). New features
should be documented in component/command docs and release notes only.
Co-Authored-By: Claude Opus 4.6 <no...@anthropic.com>
---
AGENTS.md | 12 +++++++-----
1 file changed, 7 insertions(+), 5 deletions(-)
diff --git a/AGENTS.md b/AGENTS.md
index c3b78e3b4ae0..3c1844ec279c 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -136,11 +136,13 @@ When merging a PR, an agent MUST perform the following steps **in order**:
- 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.
+ New features must be documented in the relevant command or component documentation page.
+ Changes that affect existing users upgrading must also be documented in the upgrade guide
+ (`docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_XX.adoc`). 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. The upgrade guide is for migration only — do
+ NOT add new features to it.
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.