Repository navigation
chore(agents): adopt the AGENTS.md standard and fix Markdown lint - #83
Merged
Merged
Conversation
The repository follows the AGENTS.md standard, with AGENTS.md as its only agent-instruction file. The Claude Code-specific symlink recipe and its .gitignore entries tied contributor setup to a single tool and contradicted that convention. The .gitignore comment also claimed CLAUDE.md was committed, which was no longer true. The 2.2.0 changelog and release-note entries that describe the original setup stay as released history; the removal is recorded under Unreleased. Co-Authored-By: Claude Code - Claude Opus 5.5 (medium) <noreply@anthropic.com> Signed-off-by: Luis Alfredo Perez Medina <perezmlal@outlook.com>
Bring the Markdown files in line with markdownlint defaults so lint runs stay quiet and the docs render consistently: blank lines around headings and lists, no trailing whitespace or extra blank lines, a final newline, spaced table delimiter rows, fenced blocks with a language tag, proper heading levels, and autolinked bare email addresses. Co-Authored-By: Claude Code - Claude Opus 5.5 (medium) <noreply@anthropic.com> Signed-off-by: Luis Alfredo Perez Medina <perezmlal@outlook.com>
The previous lint pass left RELEASE.md with lists that directly follow their label lines, trailing whitespace and doubled blank lines, so markdownlint still flagged it. Co-Authored-By: Claude Code - Claude Opus 5.5 (medium) <noreply@anthropic.com> Signed-off-by: Luis Alfredo Perez Medina <perezmlal@outlook.com>
1 of 4 tasks
perezmlal
added a commit
that referenced
this pull request
Oct 13, 2026
Convert the [Unreleased] CHANGELOG block to [2.3.0] and fill the gaps: the project website, Event Publisher runtime dependency bumps, the nifi-scripts Poetry resolution fix (#65), release-action SHA pinning (#87) and Werkzeug 3.1.9. Mirror the summary in RELEASE.md with the upgrade note for the MQTT Sink connector setting. Move the website entry out of [2.1.0]: it was merged after v2.2.0 and is in neither the v2.1.0 nor the v2.2.0 tree. Restore the code fences in docs/Event-Publisher.md, which #83 indented far enough to render as literal text. Signed-off-by: Luis Alfredo Perez Medina <perezmlal@outlook.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Two documentation-only changes. Nothing at runtime changes.
1. Adopt the AGENTS.md standard (
9d2e0f8)AGENTS.mdis meant to be the repository's only file of agent instructions. TheCLAUDE.md ↔ AGENTS.mdsymlink recipe, and its.gitignoreentries, tied contributor setup to one tool and went against that rule. The.gitignorecomment also saidCLAUDE.mdwas committed, which is no longer true.AGENTS.mdand the matching entries from.gitignore.CHANGELOG.mdunderUnreleased. The 2.2.0 changelog and release-note entries that describe the original setup are left as they are, since they are released history.2. Fix markdownlint findings across the docs (
7028add,23c653a)Formatting fixes in 17 Markdown files (the root community files,
docs/, and the vendored Kafka Connect README). They add blank lines around headings and lists, remove trailing whitespace and extra blank lines, add a final newline, space out table delimiter rows, add a language tag to every fenced code block, fix heading levels, and wrap the bare security contact email in angle brackets so it renders as a link.Type of change
Checklist
poetry run pytestpasses locally.ruff checkandbanditreport no new issues (see the Development guide).docs/,CHANGELOG.md).Tests: not applicable. The PR changes only Markdown and one
.gitignorecomment. No Python files change, so pytest, ruff and bandit were not run locally. CI runs them anyway.Notes for reviewers
9d2e0f8holds the only change in substance; the other two commits are formatting only.bashso that each block has a language tag.textwould describe them better if you prefer.🤖 Generated with Claude Code