Skip to content

FEAT Add GitHub Copilot Instructions for PyRIT Development#1052

Merged
bashirpartovi merged 5 commits intomicrosoft:mainfrom
bashirpartovi:dev/bashirpartovi/github-instructions
Aug 11, 2025
Merged

FEAT Add GitHub Copilot Instructions for PyRIT Development#1052
bashirpartovi merged 5 commits intomicrosoft:mainfrom
bashirpartovi:dev/bashirpartovi/github-instructions

Conversation

@bashirpartovi
Copy link
Copy Markdown
Contributor

Description

This PR introduces comprehensive GitHub Copilot instructions to standardize development practices across the PyRIT codebase.

What's Added

  • Style Guide Instructions (style-guide.instructions.md): Enforces consistent coding standards including async function naming (_async suffix), type annotations, keyword-only arguments, and documentation patterns
  • Unit Testing Instructions (unittests.instructions.md): Establishes testing standards for database isolation, async testing patterns, and comprehensive test coverage

Benefits

  • Consistency: Ensures all contributors follow the same coding standards
  • Code Quality: Enforces best practices for testing, type safety, and maintainability
  • AI-Assisted Development: Enables GitHub Copilot to generate code that follows PyRIT conventions

Comment thread .github/instructions/style-guide.instructions.md
Comment thread .github/instructions/style-guide.instructions.md
Comment thread .github/instructions/style-guide.instructions.md
Comment thread .github/instructions/style-guide.instructions.md
@bashirpartovi bashirpartovi merged commit 8868583 into microsoft:main Aug 11, 2025
20 checks passed
@bashirpartovi bashirpartovi deleted the dev/bashirpartovi/github-instructions branch August 11, 2025 19:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants