-
Notifications
You must be signed in to change notification settings - Fork 19
update changelog and review instructions #308
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
mshafer-NI
merged 5 commits into
ni:main
from
mshafer-NI:dev/update_changelog_and_review_instructions
Jun 30, 2026
+46
−1
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
f592f00
ask copilot code reviews to check a few things - including the change…
mshafer-NI 17e3a76
Update changelog for missed change
mshafer-NI 551432b
go back to unreleased tag
mshafer-NI 5d17d25
update links list at bottom
mshafer-NI ffdb4e2
Change link to instructions to be an actual link
mshafer-NI File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| # GitHub Copilot Code Review Instructions | ||
|
|
||
| ## Overview | ||
| These instructions guide code review analysis for pull requests, focusing on security, style consistency, and documentation completeness. | ||
|
|
||
| ## Review Checklist | ||
|
|
||
| ### 1. Security Issues | ||
| - **Input Validation**: Verify that user inputs, external data, and file contents are properly validated and sanitized | ||
| - **Injection Attacks**: Check for SQL injection, command injection, and code injection vulnerabilities | ||
| - **Sensitive Data**: Ensure no hardcoded secrets, API keys, passwords, or sensitive credentials are exposed | ||
| - **Dependency Vulnerabilities**: Flag any deprecated or vulnerable dependencies | ||
| - **Access Control**: Verify proper authentication and authorization checks are in place | ||
| - **Error Handling**: Check that error messages don't leak sensitive information | ||
| - **File Operations**: Ensure safe file handling with proper path validation and permissions checks | ||
|
|
||
| ### 2. Style Consistency | ||
| - **Naming Conventions**: Check that variables, functions, and classes follow project naming conventions | ||
| - **Documentation**: Verify docstrings are present in the public API and follow project conventions | ||
| - **Consistency with Existing Code**: Ensure new code matches the style and patterns used elsewhere in the project | ||
|
|
||
| ### 3. Changelog Updates | ||
| - **Behavioral Changes**: Verify that any changes to existing functionality are documented in CHANGELOG.md | ||
| - **Public API Changes**: Ensure additions, modifications, or removals of public APIs are logged | ||
| - **Breaking Changes**: Flag breaking changes and verify they are clearly documented | ||
| - **New Features**: Confirm new features are added to the changelog | ||
| - **Bug Fixes**: Check that significant bug fixes are documented | ||
| - **Versioning**: Verify that version updates align with semantic versioning principles | ||
|
|
||
| ## Reporting | ||
| When reviewing code, provide clear feedback indicating: | ||
| - Which category the issue falls under (Security, Style, or Changelog) | ||
| - The specific concern or violation | ||
| - A suggestion for resolution where applicable | ||
| - Severity level (critical, high, medium, low) |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # GitHub Copilot Code Review Instructions | ||
|
|
||
| - Load the instructions file from [.github/copilot/instructions.md](.github/copilot/instructions.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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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