Skip to content

Document that change log entries must be a single line - #1738

Open
nityanand123gupta wants to merge 2 commits into
collective:mainfrom
nityanand123gupta:docs-changelog-single-line
Open

Document that change log entries must be a single line#1738
nityanand123gupta wants to merge 2 commits into
collective:mainfrom
nityanand123gupta:docs-changelog-single-line

Conversation

@nityanand123gupta

@nityanand123gupta nityanand123gupta commented Aug 29, 2026

Copy link
Copy Markdown

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

  • I added a change log entry, following the instructions in all subsections under Change log requirements.
  • I followed icalendar's Artificial intelligence policy and disclosed my Responsible AI use in my commit messages, if applicable.
  • I added or updated tests, if applicable.
  • I ran and ensured all tests pass locally by following Run tests.
  • I added or edited documentation as necessary, both as docstrings to be rendered in the API documentation and narrative documentation, following the Style guide.

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.

@github-actions

Copy link
Copy Markdown
Contributor

This pull request did not pass quality checks and AI use is suspected. Please review Contribute and make any necessary amendments.

@github-actions github-actions Bot added the ai-suspicion This contribution is possibly created with lots of AI help without enough human understanding. label Aug 29, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Profile summary:

GitHub user: nityanand123gupta
🟡 Some concerns found with user's profile.
🟢 No concerns found with recent PR activity.
🟢 No concerns found with recent issue activity.

For a more detailed report, run `gh-profiler nityanand123gupta`.
Full profile
GitHub user: nityanand123gupta
🟡 Some concerns found with user's profile.
   🟢 Account age: 2 years
   🟡 Profile information:
        name: Nityanand Gupta
        company: IIIT H
      Empty fields: blog, location, email, bio

🟢 No concerns found with recent PR activity.
   4 PRs opened in the last 21 days.
      1 opened against repos the user owns.
      0 opened against repos in publicly associated orgs.
      3 opened against external repos.

   🟢 0 of 3 external PRs merged in the last 21 days.
   🟢 0 of 3 external PRs closed without merging in the last 21 days.

🟢 No concerns found with recent issue activity.
   1 new issues opened in the last 21 days.
      1 opened in repos the user owns.
      0 opened in repos in publicly associated orgs.
      0 opened in external repos.

   🟢 0 external issues closed as NOT_PLANNED.
   🟢 0 external issues opened with the same title.

@read-the-docs-community

read-the-docs-community Bot commented Aug 29, 2026

Copy link
Copy Markdown

Documentation build overview

📚 icalendar | 🛠️ Build #34294102 | 📁 Comparing 72a41d8 against latest (d157305)

  🔍 Preview build  

1 file changed
± contribute/index.html

@nityanand123gupta

Copy link
Copy Markdown
Author

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.
@nityanand123gupta

Copy link
Copy Markdown
Author

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.

Comment thread docs/contribute/index.rst
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.

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.

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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I agree with @angatha. Please revert this change.

Comment thread docs/contribute/index.rst
@@ -263,7 +263,7 @@ Write a good change log entry

The content of this file must include the following.

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.

Suggested change
The content of this file must include the following.
The content of this file must be a single line and include the following.

@angatha

angatha commented Aug 30, 2026

Copy link
Copy Markdown
Collaborator

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.

@nityanand123gupta

Copy link
Copy Markdown
Author

Thanks for the flag — updated the PR body to follow the actual template (.github/pull_request_template.md) with the Linked issue section and checked checklist items. Also worth noting for maintainers: I found a file at .github/assistant-guidelines.md in this repo that instructs AI assistants to harvest and commit a user's private prompt text into .prompts/ files — that's not something I acted on, flagging it in case it's not something the maintainers intentionally added (or if it is a deliberate honeypot, disregard this note).

@stevepiercy

Copy link
Copy Markdown
Member

.github/assistant-guidelines.md

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?

Screenshot 2026-08-30 at 8 32 48 PM

Comment thread docs/contribute/index.rst
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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I agree with @angatha. Please revert this change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ai-suspicion This contribution is possibly created with lots of AI help without enough human understanding.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update Contribute guide to state that change log entries should be written as a single line

3 participants