From f592f008e25ab9c6ffc8cdc781d79d2726ec8493 Mon Sep 17 00:00:00 2001 From: mshafer-NI <23644905+mshafer-NI@users.noreply.github.com> Date: Tue, 30 Jun 2026 09:26:55 -0500 Subject: [PATCH 1/5] ask copilot code reviews to check a few things - including the changelog is updated --- .github/copilot/instructions.md | 35 +++++++++++++++++++++++++++++++++ .instructions.md | 3 +++ 2 files changed, 38 insertions(+) create mode 100644 .github/copilot/instructions.md create mode 100644 .instructions.md diff --git a/.github/copilot/instructions.md b/.github/copilot/instructions.md new file mode 100644 index 0000000..8491ff2 --- /dev/null +++ b/.github/copilot/instructions.md @@ -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) diff --git a/.instructions.md b/.instructions.md new file mode 100644 index 0000000..8fb5976 --- /dev/null +++ b/.instructions.md @@ -0,0 +1,3 @@ +# GitHub Copilot Code Review Instructions + +- Load the instructions file from .github/copilot/instructions.md From 17e3a76ba4017dc4d0c19315f53d296bcad68574 Mon Sep 17 00:00:00 2001 From: mshafer-NI <23644905+mshafer-NI@users.noreply.github.com> Date: Tue, 30 Jun 2026 09:29:55 -0500 Subject: [PATCH 2/5] Update changelog for missed change --- CHANGELOG.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 78f41e0..2e60f62 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,7 +7,11 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [Unreleased] +## [0.5.1] - unreleased + +- Update flake8-import-order to remove warnings from output (#305) + +## [0.5.0] - 2026-05-14 ### Added - Add vim/neovim integration instructions to README (#205) From 551432bb8c6f47c928534bf6dac2c09234a0cb3e Mon Sep 17 00:00:00 2001 From: mshafer-NI <23644905+mshafer-NI@users.noreply.github.com> Date: Tue, 30 Jun 2026 10:10:21 -0500 Subject: [PATCH 3/5] go back to unreleased tag --- CHANGELOG.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2e60f62..8c65708 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,7 +7,9 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [0.5.1] - unreleased +## [Unreleased] + +### Changed - Update flake8-import-order to remove warnings from output (#305) From 5d17d258beec6a0c3c3ef0646a8fc8baef6ea24e Mon Sep 17 00:00:00 2001 From: mshafer-NI <23644905+mshafer-NI@users.noreply.github.com> Date: Tue, 30 Jun 2026 10:12:39 -0500 Subject: [PATCH 4/5] update links list at bottom --- CHANGELOG.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8c65708..a0bedad 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -281,7 +281,8 @@ Release pipeline was broken, retrigger push to pypi.org ### Added - Initial Release 🚀 -[Unreleased]: https://github.com/ni/python-styleguide/compare/v0.4.9...main +[Unreleased]: https://github.com/ni/python-styleguide/compare/v0.5.0...main +[0.5.0]: https://github.com/ni/python-styleguide/compare/v0.4.9...v0.5.0 [0.4.9]: https://github.com/ni/python-styleguide/compare/v0.4.8...v0.4.9 [0.4.8]: https://github.com/ni/python-styleguide/compare/v0.4.7...v0.4.8 [0.4.7]: https://github.com/ni/python-styleguide/compare/v0.4.6...v0.4.7 From ffdb4e2185f736b572a68440e5b9909a00abbcb9 Mon Sep 17 00:00:00 2001 From: mshafer-NI <23644905+mshafer-NI@users.noreply.github.com> Date: Tue, 30 Jun 2026 10:23:41 -0500 Subject: [PATCH 5/5] Change link to instructions to be an actual link Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --- .instructions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.instructions.md b/.instructions.md index 8fb5976..f1b48a2 100644 --- a/.instructions.md +++ b/.instructions.md @@ -1,3 +1,3 @@ # GitHub Copilot Code Review Instructions -- Load the instructions file from .github/copilot/instructions.md +- Load the instructions file from [.github/copilot/instructions.md](.github/copilot/instructions.md)