update changelog and review instructions#308
Merged
mshafer-NI merged 5 commits intoJun 30, 2026
Merged
Conversation
Contributor
|
Thank you for contributing! 👋 |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates project documentation to reflect an upcoming change (flake8-import-order warning reduction) and introduces GitHub Copilot code review instruction files to encourage checking changelog completeness during reviews.
Changes:
- Adds a new (unreleased) changelog entry for version 0.5.1 referencing the flake8-import-order update.
- Adds a root
.instructions.mdpointer and a detailed.github/copilot/instructions.mdchecklist for Copilot-driven reviews.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| CHANGELOG.md | Adds a new 0.5.1 changelog entry documenting the flake8-import-order update. |
| .instructions.md | Adds a short pointer to the Copilot instructions file path. |
| .github/copilot/instructions.md | Adds a review checklist with an explicit section reminding reviewers to validate changelog updates. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
irwand
approved these changes
Jun 30, 2026
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
bkeryan
reviewed
Jun 30, 2026
Collaborator
There was a problem hiding this comment.
FYI we have had success with adding a checkbox to the pull request template: https://github.com/ni/nidaqmx-python/blob/master/.github/PULL_REQUEST_TEMPLATE.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Document the update of
flake8-import-orderto remove warnings inCHANGELOG.mdunder the unreleased section as preparation for releasing 0.5.1.Also add instructions for copilot to review if the changelog is out of date.