Skip to content

[chores] Changelog bot: asked LLM to use past tense#703

Merged
nemesifier merged 1 commit into
masterfrom
changelog-past-tense
Jun 19, 2026
Merged

[chores] Changelog bot: asked LLM to use past tense#703
nemesifier merged 1 commit into
masterfrom
changelog-past-tense

Conversation

@nemesifier

@nemesifier nemesifier commented Jun 19, 2026

Copy link
Copy Markdown
Member

Checklist

  • I have read the OpenWISP Contributing Guidelines.
  • I have manually tested the changes proposed in this pull request.
  • N/A I have written new test cases for new code and/or updated existing tests for changes to existing code.
  • N/A I have updated the documentation.

Reference to Existing Issue

No existing issue. Small refinement, issue not needed.

Description of Changes

The changelog bot's system prompt did not explicitly instruct the LLM to use past tense for the generated commit message. The example output happened to use past tense ('Added'), but there was no explicit rule enforcing it.

Changes:

  • Added the rule: 'Use past tense for the commit message (e.g., Added, Fixed, Changed)' to the system instruction in build_prompt().
  • Updated the corresponding test in test_builds_basic_prompt to assert that this rule is present in the prompt.

All tests and QA checks pass.

Screenshot

Not applicable.

@coderabbitai

coderabbitai Bot commented Jun 19, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

A single rule is added to the LLM system prompt in the changelog generator script, requiring that commit messages use past tense phrasing (e.g., "Added", "Fixed", "Changed"). A corresponding assertion is added to the TestBuildPrompt.test_builds_basic_prompt test to verify that the generated system_instruction string contains this new rule.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested labels

github_actions, helper-bots

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: updating the changelog bot to enforce past tense in LLM-generated commit messages, and follows the required format '[type] Descriptive title'.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Bug Fixes ✅ Passed The PR is not a bug fix—it adds explicit LLM instructions to prevent deviations from past tense in commit messages, not fixing existing incorrect behavior. Bug-fix checks don't apply.
Description check ✅ Passed The pull request description adequately covers the changes made, reasoning, and testing status, though some checklist items are marked as N/A.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch changelog-past-tense

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@kilo-code-bot

kilo-code-bot Bot commented Jun 19, 2026

Copy link
Copy Markdown

Code Review Summary

Status: No Issues Found | Recommendation: Merge

Files Reviewed (2 files)
  • .github/actions/bot-changelog-generator/generate_changelog.py
  • .github/actions/bot-changelog-generator/test_generate_changelog.py

Reviewed by glm-5.2-20260616 · Input: 59.5K · Output: 474 · Cached: 4

@nemesifier nemesifier self-assigned this Jun 19, 2026
@coderabbitai coderabbitai Bot added github_actions Pull requests that update GitHub Actions code helper-bots Helper bots, release management automation labels Jun 19, 2026
@nemesifier nemesifier added enhancement and removed github_actions Pull requests that update GitHub Actions code helper-bots Helper bots, release management automation labels Jun 19, 2026
@nemesifier
nemesifier merged commit 595ddbf into master Jun 19, 2026
37 checks passed
@nemesifier
nemesifier deleted the changelog-past-tense branch June 19, 2026 17:10
@coveralls

Copy link
Copy Markdown

Coverage Status

coverage: 97.586%. remained the same — changelog-past-tense into master

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants