Adds a mandatory CHANGELOG.md file that PRs have to update#1276
Adds a mandatory CHANGELOG.md file that PRs have to update#1276finbarrtimbers merged 8 commits intomainfrom
CHANGELOG.md file that PRs have to update#1276Conversation
Summary of ChangesHello @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 Highlights
Ignored Files
Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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.
| ### Removed | |
| ### Removed | |
| ### Deprecated | |
| ### Security |
bafba21 to
98fc3d8
Compare
…#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
…#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
Now, when you submit a PR, you have to update
CHANGELOG.mdand 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: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.
/.github/workflows/pr_checks.yml:CHANGELOGcheck: requiresCHANGELOG.mdupdate and PR URL; bypass viaCHANGELOG=<reason>; only enforced foropen_instruct/**changes.make style-checkandmake quality-checkusingastral-sh/setup-uv@v4./.github/workflows/quality.yml.CHANGELOG.mdwith an Unreleased section and entry citing this PR.Written by Cursor Bugbot for commit 83aab2b. This will update automatically on new commits. Configure here.