docs: add instructions for code review, commit message, and changelog generation#2491
Merged
rinatkhaziev merged 12 commits intotrunkfrom Aug 14, 2025
Merged
docs: add instructions for code review, commit message, and changelog generation#2491rinatkhaziev merged 12 commits intotrunkfrom
rinatkhaziev merged 12 commits intotrunkfrom
Conversation
Contributor
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation for standardizing development processes through AI-assisted tooling. It introduces four instruction files that establish guidelines for code reviews, commit messages, and changelog generation to ensure consistency across the project.
- Adds structured templates for AI-generated code reviews with focus on security, performance, and maintainability
- Establishes Conventional Commits format with detailed body requirements and scope guidelines
- Creates separate instruction sets for technical and user-facing changelog generation
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
.github/instructions/code-review.instructions.md |
Defines comprehensive code review format and criteria for AI assistants |
.github/instructions/commit-message.instructions.md |
Establishes Conventional Commits standard with required body structure |
.github/instructions/tech-changelog.instructions.md |
Provides guidelines for generating technical changelogs for developers |
.github/instructions/user-changelog.instructions.md |
Sets format for user-friendly changelogs without technical jargon |
Contributor
|
This is awesome, I think it would be even more awesome to make it generate the doc draft to kickstart Yoli's work. |
sjinks
force-pushed
the
add/copilot-instructions
branch
from
4fb9b6d to
d5e4b09
Compare
Member
Author
|
This is how the dependency-audit-edited.mp4See #2497 for the actual report |
13 tasks
Member
Author
|
Automatic commit message generation: commit-message.mp4 |
sjinks
force-pushed
the
add/copilot-instructions
branch
from
68e411f to
cae0d9e
Compare
… generation This commit introduces new documentation files that provide clear guidelines for generating code reviews, commit messages, and technical/user-facing changelogs. These instructions aim to ensure consistency and clarity in the development process. Key Changes: - Added `code-review.instructions.md` for AI-assisted code reviews. - Added `commit-message.instructions.md` to standardize commit messages. - Added `tech-changelog.instructions.md` for generating technical changelogs. - Added `user-changelog.instructions.md` for user-facing changelog entries. These documents will help maintain high-quality contributions and improve the overall developer experience.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Introduces a new prompt for auditing dependencies in Node.js/TypeScript projects. This includes detailed instructions for dependency discovery, version analysis, security vulnerability scanning, license compliance, and more. The prompt aims to enhance security and maintainability by providing structured guidance for developers to assess and optimize their project dependencies.
This commit introduces a comprehensive security audit prompt specifically designed for Node.js and TypeScript CLI applications. The prompt outlines detailed instructions for performing a systematic security assessment, including guidelines for dependency security, input validation, and secrets management. Key changes include: - Added sections for various security concerns - Included required tools and commands for the audit process - Provided a structured format for reporting findings This enhancement aims to improve security practices within Node.js/TypeScript projects by providing clear guidance for developers.
sjinks
force-pushed
the
add/copilot-instructions
branch
from
8c653cd to
c3a1bf8
Compare
Added emphasis on prioritizing semantic search throughout the dependency audit process to improve identification of actual dependency usage patterns and potential issues. Updated instructions to include specific semantic search applications across various audit steps for better clarity and effectiveness.
Enhanced the installation process for Semgrep and CodeQL by adding fallback options and architecture detection. This ensures a smoother setup experience for users on different systems. Key changes include: - Added snap installation option for Semgrep on Ubuntu. - Implemented architecture detection for CodeQL download. - Improved checks for existing installations. No functional changes to the security audit process.
|
rinatkhaziev
approved these changes
Aug 14, 2025
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.
Description
This commit introduces new documentation files that provide clear guidelines for generating code reviews, commit messages, and technical/user-facing changelogs. These instructions aim to ensure consistency and clarity in the development process.
Key Changes:
code-review.instructions.mdfor AI-assisted code reviews.commit-message.instructions.mdto standardize commit messages.tech-changelog.instructions.mdfor generating technical changelogs.user-changelog.instructions.mdfor user-facing changelog entries.These documents will help maintain high-quality contributions and improve the overall developer experience.