Skip to content

AGENTS.md: clarify changelog fragment rules - #13135

Merged
russoz merged 2 commits into
ansible-collections:mainfrom
russoz-ansible:agents-md-changelog-fragments
Oct 30, 2026
Merged

russoz merged 2 commits into
ansible-collections:mainfrom
russoz-ansible:agents-md-changelog-fragments

Conversation

@russoz

@russoz russoz commented Oct 30, 2026

Copy link
Copy Markdown
Collaborator
SUMMARY

Tighten the changelog fragment rules in AGENTS.md:

  • Require the PR URL in every fragment entry, with an example, as LLM-generated contributions frequently omit it.
  • Record changes to module utils and plugin utils (including _-prefixed ones) when they affect previously existing modules or plugins; changes serving only a new module or plugin need no fragment.
  • One entry per plugin changed, rather than per file.
  • Descriptions are a single short sentence; acronyms are always upper-case; entries containing : must be quoted.
  • Move the note about not creating an issue after the PR to the PR rules section.

AI (Claude) was used to draft these changes.

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

AGENTS.md

🤖 Generated with Claude Code

Require the PR URL in every fragment entry, clarify how module utils
and plugin utils changes are recorded, and tighten the description
wording rules.

Assisted-by: Claude Opus 5.5
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@felixfontein felixfontein added backport-12 Automatically create a backport for the stable-12 branch backport-13 Automatically create a backport for the stable-13 branch labels Oct 30, 2026

@felixfontein felixfontein left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks!

Comment thread AGENTS.md Resolved
Comment thread AGENTS.md Resolved
@felixfontein felixfontein added the check-before-release PR will be looked at again shortly before release and merged if possible. label Oct 30, 2026
Assisted-by: Claude Opus 5.5
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@russoz
russoz merged commit 0a4871b into ansible-collections:main Oct 30, 2026
138 checks passed
@russoz
russoz deleted the agents-md-changelog-fragments branch October 30, 2026 21:10
@patchback

patchback Bot commented Oct 30, 2026 •

Copy link
Copy Markdown

Backport to stable-13: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-13/0a4871b01c734d29bccf5da6fc951bbb01c1e388/pr-13135

Backported as #13163

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

@russoz

russoz commented Oct 30, 2026

Copy link
Copy Markdown
Collaborator Author

@felixfontein and yet another one

@patchback

patchback Bot commented Oct 30, 2026 •

Copy link
Copy Markdown

Backport to stable-12: 💔 cherry-picking failed — conflicts found

❌ Failed to cleanly apply 0a4871b on top of patchback/backports/stable-12/0a4871b01c734d29bccf5da6fc951bbb01c1e388/pr-13135

Backporting merged PR #13135 into main

  1. Ensure you have a local repo clone of your fork. Unless you cloned it
    from the upstream, this would be your origin remote.
  2. Make sure you have an upstream repo added as a remote too. In these
    instructions you'll refer to it by the name upstream. If you don't
    have it, here's how you can add it:
    git remote add upstream https://github.com/ansible-collections/community.general.git
    
  3. Ensure you have the latest copy of upstream and prepare a branch
    that will hold the backported code:
    git fetch upstream
    git checkout -b patchback/backports/stable-12/0a4871b01c734d29bccf5da6fc951bbb01c1e388/pr-13135 upstream/stable-12
    
  4. Now, cherry-pick PR AGENTS.md: clarify changelog fragment rules #13135 contents into that branch:
    git cherry-pick -x 0a4871b01c734d29bccf5da6fc951bbb01c1e388
    
    If it'll yell at you with something like fatal: Commit 0a4871b01c734d29bccf5da6fc951bbb01c1e388 is a merge but no -m option was given., add -m 1 as follows instead:
    git cherry-pick -m1 -x 0a4871b01c734d29bccf5da6fc951bbb01c1e388
    
  5. At this point, you'll encounter some merge conflicts. You must
    resolve them in order to preserve the patch from PR AGENTS.md: clarify changelog fragment rules #13135 as close to the
    original as possible.
  6. Once conflicts are resolved and git added, run:
    git cherry-pick --continue
    
  7. Push this branch to your fork on GitHub:
    git push origin patchback/backports/stable-12/0a4871b01c734d29bccf5da6fc951bbb01c1e388/pr-13135
    
  8. Create a PR, ensure that the CI is green. If it's not — update it so that
    the tests and any other checks pass. This is it!
    Now relax and wait for the maintainers to process your pull request
    when they have some cycles to do reviews. Don't worry — they'll tell you if
    any improvements are necessary when the time comes!

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

@felixfontein felixfontein removed the check-before-release PR will be looked at again shortly before release and merged if possible. label Oct 30, 2026
felixfontein pushed a commit that referenced this pull request Oct 30, 2026
… fragment rules (#13163)

AGENTS.md: clarify changelog fragment rules (#13135)

* docs(AGENTS.md): clarify changelog fragment rules

Require the PR URL in every fragment entry, clarify how module utils
and plugin utils changes are recorded, and tighten the description
wording rules.

Assisted-by: Claude Opus 5.5


* docs(AGENTS.md): name affected plugins for changes in private utils

Assisted-by: Claude Opus 5.5


---------


(cherry picked from commit 0a4871b)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport-12 Automatically create a backport for the stable-12 branch backport-13 Automatically create a backport for the stable-13 branch docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants