Skip to content

Adds a mandatory CHANGELOG.md file that PRs have to update#1276

Merged
finbarrtimbers merged 8 commits intomainfrom
finbarr/changelog
Jan 19, 2026
Merged

Adds a mandatory CHANGELOG.md file that PRs have to update#1276
finbarrtimbers merged 8 commits intomainfrom
finbarr/changelog

Conversation

@finbarrtimbers
Copy link
Collaborator

@finbarrtimbers finbarrtimbers commented Dec 12, 2025

Now, when you submit a PR, you have to update CHANGELOG.md and include a link to the PR in your description. However, if you include CHANGELOG= in the PR body, the changelog check will be bypassed and print the reason you provided. For example:

CHANGELOG=internal refactor, no user-facing changes


Note

Introduces a new PR checks workflow that enforces CHANGELOG updates (with bypass), runs style/quality checks, removes the old quality workflow, and adds a CHANGELOG.md.

  • CI:
    • New workflow /.github/workflows/pr_checks.yml:
      • CHANGELOG check: requires CHANGELOG.md update and PR URL; bypass via CHANGELOG=<reason>; only enforced for open_instruct/** changes.
      • Code quality: runs make style-check and make quality-check using astral-sh/setup-uv@v4.
    • Removed legacy /.github/workflows/quality.yml.
  • Docs:
    • Added CHANGELOG.md with an Unreleased section and entry citing this PR.

Written by Cursor Bugbot for commit 83aab2b. This will update automatically on new commits. Configure here.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @finbarrtimbers, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a new CHANGELOG.md file to standardize the documentation of project changes. The primary goal is to ensure that all future modifications are recorded in a consistent and accessible format, thereby improving transparency and maintainability for both users and contributors.

Highlights

  • New CHANGELOG.md File: A new CHANGELOG.md file has been added to the repository. This file will serve as the central place for documenting all notable changes to the project.
  • Mandatory Changelog Updates: All future pull requests will now be required to update this CHANGELOG.md file, ensuring that project changes are consistently documented.
Ignored Files
  • Ignored by pattern: .github/workflows/** (1)
    • .github/workflows/pr_checks.yml
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces a CHANGELOG.md file to track notable changes to the project. This is a great addition for project maintainability. My feedback includes a suggestion to add a couple of standard sections to the changelog to make it more comprehensive, following the 'Keep a Changelog' convention.


### Fixed

### Removed
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

To better align with the Keep a Changelog standard, it would be beneficial to also include sections for Deprecated and Security changes. This will provide a more comprehensive structure for documenting all types of changes in the future.

Suggested change
### Removed
### Removed
### Deprecated
### Security

@finbarrtimbers finbarrtimbers marked this pull request as ready for review December 12, 2025 22:41
@finbarrtimbers finbarrtimbers added this pull request to the merge queue Jan 19, 2026
Merged via the queue into main with commit f5ea979 Jan 19, 2026
7 checks passed
@finbarrtimbers finbarrtimbers deleted the finbarr/changelog branch January 19, 2026 17:42
sang1583535 pushed a commit to sang1583535/open-instruct that referenced this pull request Feb 3, 2026
…#1276)

* Added changelog and PR check

* Integrated quality check with pr_checks.

* added changelog description

* Updated changelog with PR link.

* Cleaned up changelog check.

* Fixed bug that cursor pointed out.

* Update CHANGELOG.md

* now changelog has the same default
lukashelff pushed a commit to lukashelff/open-instruct-slurm that referenced this pull request Feb 19, 2026
…#1276)

* Added changelog and PR check

* Integrated quality check with pr_checks.

* added changelog description

* Updated changelog with PR link.

* Cleaned up changelog check.

* Fixed bug that cursor pointed out.

* Update CHANGELOG.md

* now changelog has the same default
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants