Document that change log entries must be a single line - #1738
Document that change log entries must be a single line#1738nityanand123gupta wants to merge 2 commits into
Conversation
|
This pull request did not pass quality checks and AI use is suspected. Please review Contribute and make any necessary amendments. |
|
Profile summary: Full profile |
|
Hi, just checking in on PR #4016. Happy to make any changes if needed. Thanks! |
AI model and version: Claude, Sonnet 5 (claude-sonnet-5), via Claude Code. How it was used: The full change (documenting the single-line change log requirement, and this changelog entry itself) was drafted by the AI, directed by the repository owner, in response to issue collective#1737 which predates this PR. The AI read the existing docs/contribute/index.rst content and the existing news/ entries to match the file's established convention, then added one bullet point stating the single-line requirement explicitly, plus this changelog entry. The repository owner reviewed and takes responsibility for the change.
|
Thanks for the flag — you're right, I should have disclosed this upfront rather than leaving it for the bot to catch. I used AI (Claude, Sonnet 5) to draft this change, directed and reviewed by me (the repository owner of this fork). Just pushed a commit with the full disclosure (AI model/version + how it was used) and updated the change log entry to include the required brief disclosure line, per the Responsible AI use policy. Apologies for missing this the first time — happy to make any further changes needed. |
| The content of this file must include the following. | ||
|
|
||
| - A brief message that summarizes the changes in your contribution. | ||
| - A brief message that summarizes the changes in your contribution, written as a single line, without wrapped or multi-line paragraphs. |
There was a problem hiding this comment.
Readers may assume that this applies only to the summary, so this may seems fine:
Lorem Ipsum
I did not use AI
@angatha
See other comment.
| @@ -263,7 +263,7 @@ Write a good change log entry | |||
|
|
|||
| The content of this file must include the following. | |||
There was a problem hiding this comment.
| The content of this file must include the following. | |
| The content of this file must be a single line and include the following. |
|
Your contribution was flagged with ai-suspicion because you failed to use the PR template. Please use it for future contributions. You then need to check each checkbox. |
|
Thanks for the flag — updated the PR body to follow the actual template ( |
You can examine its history, which might help you understand why it's there, instead of needlessly flagging it. I wonder if AI told you to flag it?
|
| The content of this file must include the following. | ||
|
|
||
| - A brief message that summarizes the changes in your contribution. | ||
| - A brief message that summarizes the changes in your contribution, written as a single line, without wrapped or multi-line paragraphs. |

Linked issue
Description
The contributing guide describes what a good change log entry should contain, but never states that entries must be written as a single line — even though every existing entry in
news/follows that convention. Adds it explicitly to reduce ambiguity for first-time contributors.Checklist
Additional information
This is a docs-only change to
docs/contribute/index.rst(adding one clause to an existing bullet point) — no code was touched, so the test-related checklist items don't apply here.