You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by or...@apache.org on 2026/06/25 14:13:40 UTC
(camel) 01/02: Added support for the OpenHarnessEngineering helper files
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 82867b36afeea67c448b11123a6ab94d1caa2d57
Author: Otavio Rodolfo Piske <an...@gmail.com>
AuthorDate: Thu Jun 25 15:15:03 2026 +0200
Added support for the OpenHarnessEngineering helper files
Includes:
- Add AI-assisted contributions section to contributing guide
---
.gitignore | 3 +--
.oss-ai-helper-rules/project-guidelines.md | 21 +++++++++++++++++++++
.oss-ai-helper-rules/project-info.md | 14 ++++++++++++++
.oss-ai-helper-rules/project-standards.md | 16 ++++++++++++++++
docs/main/modules/contributing/pages/index.adoc | 9 +++++++++
5 files changed, 61 insertions(+), 2 deletions(-)
diff --git a/.gitignore b/.gitignore
index c00c857ddc1c..6a653dcd0b9f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -33,5 +33,4 @@ mvnd.zip*
.mvn/.develocity/develocity-workspace-id
backlog
.claude
-.omc
-.oss-ai-helper-rules
\ No newline at end of file
+.omc
\ No newline at end of file
diff --git a/.oss-ai-helper-rules/project-guidelines.md b/.oss-ai-helper-rules/project-guidelines.md
new file mode 100644
index 000000000000..7b9ed977994f
--- /dev/null
+++ b/.oss-ai-helper-rules/project-guidelines.md
@@ -0,0 +1,21 @@
+# Project Guidelines
+
+This rule file contains branching, commit, PR, and task-finding conventions for the project. Commands read this file to determine how to name branches, format commits, and search for tasks.
+
+- **Fix branch:** `fix/<ISSUE_ID>`
+- **Feature branch:** `feature/<ISSUE_ID>-<short-slug>`
+- **Bugfix branch:** `bugfix/<ISSUE_ID>`
+- **Quick-fix branch:** `quick-fix/<short-slug>`
+- **SonarCloud branch:** `ci-camel-4-sonarcloud-<rule>` (customizable via `branch=<name>` option)
+- **Commit format (fix):** `<ISSUE_ID>: <brief description of fix>`
+- **Commit format (quick-fix):** `chore: <brief description>`
+- **CI-issue branch:** `ci-issue/<short-slug>`
+- **Commit format (ci-issue):** `ci: <brief description>`
+- **Commit format (sonarcloud):** `(chores): fix SonarCloud <rule> in <component>`
+- **PR creation:** always
+- **Backport upgrade-guide policy:** the `docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_XX.adoc` files for ALL versions live on `main` and act as the canonical history across all releases. When a PR is backported to a maintenance branch (e.g. `camel-4.18.x`, `camel-4.14.x`) and adds an upgrade-guide note for that release line, the corresponding entry must ALSO be added to the matching `camel-4x-upgrade-guide-4_XX.adoc` file on `main` — either as part of the backport workfl [...]
+- **Find-task source:** Jira
+- **Find-task beginner JQL:** `project = CAMEL AND status = Open AND labels = good-first-issue` (maxResults=10)
+- **Find-task intermediate:** Filter 12352792 (easy issues)
+- **Find-task experienced JQL:** `project = CAMEL AND status = Open AND labels = help-wanted` (maxResults=10)
+- **Scope-too-large redirect:** create a Jira issue directly
diff --git a/.oss-ai-helper-rules/project-info.md b/.oss-ai-helper-rules/project-info.md
new file mode 100644
index 000000000000..f80d08d6c37b
--- /dev/null
+++ b/.oss-ai-helper-rules/project-info.md
@@ -0,0 +1,14 @@
+# Project Information
+
+This rule file contains project-specific metadata used by OSS Helper commands. Commands detect the current project by matching `git remote get-url origin` against the remote pattern below.
+
+- **Remote pattern:** `apache/camel`
+- **GitHub repo:** `apache/camel`
+- **Issue tracker:** Jira
+- **Issue tracker URL:** `https://issues.apache.org/jira/browse/`
+- **Issue ID format:** alphanumeric (e.g., `CAMEL-20410`)
+- **SonarCloud component key:** `apache_camel`
+- **Documentation URL:** _(none)_
+- **Related repositories:** _(none)_
+- **Jira project key:** `CAMEL`
+- **Create-issue supported:** yes
diff --git a/.oss-ai-helper-rules/project-standards.md b/.oss-ai-helper-rules/project-standards.md
new file mode 100644
index 000000000000..f5d1549de9d0
--- /dev/null
+++ b/.oss-ai-helper-rules/project-standards.md
@@ -0,0 +1,16 @@
+# Project Standards
+
+This rule file contains build tools, commands, and code style constraints for the project. Commands read this file to determine how to build, test, and format code.
+
+- **Build tool:** Maven
+- **Build command:** `mvn -Dquickly install`
+- **Test command:** `mvn verify`
+- **Format command:** `cd <module> && mvn -DskipTests install`
+- **Module-specific build:** yes (always run `mvn` in the module directory where changes occurred)
+- **Parallelized Maven:** no (resource intensive, do NOT parallelize Maven jobs)
+- **Code style restrictions:**
+ - Do NOT use Lombok (unless already present in the file)
+ - Do NOT change public API signatures without justification
+ - Do NOT add new dependencies without justification
+ - Maintain backwards compatibility for public APIs
+
diff --git a/docs/main/modules/contributing/pages/index.adoc b/docs/main/modules/contributing/pages/index.adoc
index 5ef786778fac..0a2ef970de7e 100644
--- a/docs/main/modules/contributing/pages/index.adoc
+++ b/docs/main/modules/contributing/pages/index.adoc
@@ -345,6 +345,15 @@ As part of our https://ci-builds.apache.org/job/Camel/[Continuous Integration],
Apache Camel Committers and contributors are encouraged to analyze the quality reports and suggest fixes and improvements.
+== AI-assisted contributions
+
+Contributors using AI coding assistants (such as https://github.com/anthropics/claude-code[Claude Code] or similar tools) can take advantage of the project rules in the `.oss-ai-helper-rules/` directory and the `CLAUDE.md` file at the repository root.
+
+These files provide AI agents with project-specific context such as build commands, code style restrictions, branching conventions, issue tracker details, and contribution guidelines.
+They are maintained as part of the repository so that AI-assisted contributions follow the same standards as manual ones.
+
+The `.oss-ai-helper-rules/` files are designed for use with the https://github.com/Open-Harness-Engineering/ai-agents-oss-helper[OSS Helper] toolset, which provides ready-made skills for common contribution tasks (fixing issues, creating PRs, running CI checks, and more).
+
== Becoming a committer
Once you have become sufficiently involved with the community, we may well invite you to be a committer. See xref:manual:faq:how-do-i-become-a-committer.adoc[How do I become a committer] for more details.