Skip to content

EBP-3229: Add CLAUDE.md and refresh the root README - #11

Merged
aelsammak merged 1 commit into
devfrom
EBP-3229
Oct 8, 2026
Merged

aelsammak merged 1 commit into
devfrom
EBP-3229

Conversation

@aelsammak

Copy link
Copy Markdown

What is the purpose of this change?

The repository has no agent orientation file, and the root README still describes the application development skill as JCSMP only with full guidance "in upcoming releases". This change adds a root CLAUDE.md and brings the README in line with what the skills do today.

How is this accomplished?

  1. Added a root CLAUDE.md with a map of where skills, references, evals, and tools live, the exact check and eval commands, repo conventions, a "Gotchas / do not" section, and the PR workflow for agents.
  2. Updated the README intro and the solace-application-development row to describe the current JCSMP and Python coverage.
  3. Added a Contributing section that states external PRs and issues are not accepted and routes bugs and feature requests to Solace Support, the Solace Ideas portal, or the Solace Community.
  4. Listed CLAUDE.md in the repository layout and described tools/ by role instead of by file name.

Anything reviews should focus on/be aware of?

  • Both files are public and the README ships to customers on release, so please check the Contributing wording.
  • Documentation only: no skill content changes, so no version bump and no trigger or output eval runs. claude plugin validate . --strict and ./tools/check-plugin-versions.sh --sync-only pass locally.
  • Please check the CLAUDE.md commands and gotchas against your own experience in the repo.

- Add a root CLAUDE.md for AI coding agents: where the skills, references,
  evals, and tools live, the exact check and eval commands, repo conventions,
  a gotchas section, and the PR workflow
- Update the README intro and the solace-application-development row to
  describe the current JCSMP and Python coverage instead of future releases
- Add a Contributing section that routes bugs and feature requests to Solace
  Support, the Solace Ideas portal, or the Solace Community
- List CLAUDE.md in the repository layout and describe tools/ by role
@mtite-sol
mtite-sol self-requested a review October 8, 2026 18:19

@mtite-sol mtite-sol left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes LGTM!

@aelsammak
aelsammak marked this pull request as ready for review October 8, 2026 18:21
@aelsammak
aelsammak merged commit 04b621b into dev Oct 8, 2026
4 checks passed
@aelsammak
aelsammak deleted the EBP-3229 branch October 8, 2026 18:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants