Skip to content

Conversation

@bencap
Copy link
Collaborator

@bencap bencap commented Nov 3, 2025

  • Create copilot-instructions.md with core directives, interaction philosophy, and development patterns for MaveDB API.
  • Establish instructions.instructions.md for creating high-quality custom instruction files for GitHub Copilot.
  • Introduce markdown.instructions.md outlining documentation and content creation standards.
  • Develop prompt.instructions.md detailing guidelines for crafting effective prompt files for GitHub Copilot.
  • Implement python.instructions.md to specify Python coding conventions and guidelines.
  • Add prompt-builder.prompt.md to guide users in creating structured and effective GitHub Copilot prompts.

Included files are inspired by or from the prompt and instructions files available at https://github.com/github/awesome-copilot/blob/main.

…idelines

- Create copilot-instructions.md with core directives, interaction philosophy, and development patterns for MaveDB API.
- Establish instructions.instructions.md for creating high-quality custom instruction files for GitHub Copilot.
- Introduce markdown.instructions.md outlining documentation and content creation standards.
- Develop prompt.instructions.md detailing guidelines for crafting effective prompt files for GitHub Copilot.
- Implement python.instructions.md to specify Python coding conventions and guidelines.
- Add prompt-builder.prompt.md to guide users in creating structured and effective GitHub Copilot prompts.

Included files are inspired by or from the prompt and instructions files available at https://github.com/github/awesome-copilot/blob/main
@bencap bencap requested a review from Copilot November 3, 2025 21:01
@bencap
Copy link
Collaborator Author

bencap commented Nov 3, 2025

AInception

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR establishes a comprehensive GitHub Copilot configuration framework for the MaveDB API project by introducing six instruction and prompt files that define development standards, AI interaction guidelines, and prompt engineering best practices.

Key Changes:

  • Implements domain-specific instruction files covering Python development, Markdown documentation, prompt engineering, and general instruction file creation
  • Introduces a MaveDB-specific Copilot instruction file that defines bioinformatics development patterns, architecture overview, and project conventions
  • Adds comprehensive AI safety and prompt engineering guidelines covering bias mitigation, security, and responsible AI usage
  • Provides a prompt builder tool to help developers create effective GitHub Copilot prompts

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
.github/prompts/prompt-builder.prompt.md Interactive guide for creating structured GitHub Copilot prompt files with comprehensive questionnaire and template generation
.github/instructions/python.instructions.md Python-specific coding conventions including PEP 8 compliance, type hints, docstring standards, and testing guidelines
.github/instructions/prompt.instructions.md Guidelines for creating effective prompt files including frontmatter requirements, file structure, and quality assurance checklist
.github/instructions/markdown.instructions.md Documentation standards covering content rules, formatting guidelines, and validation requirements for Markdown files
.github/instructions/instructions.instructions.md Meta-guidelines for creating instruction files with structure templates, content guidelines, and maintenance procedures
.github/instructions/copilot-instructions.md MaveDB-specific development guide covering bioinformatics patterns, architecture, database models, and project conventions
.github/instructions/ai-prompt-engineering-safety-best-practices.instructions.md Comprehensive AI safety framework covering prompt engineering fundamentals, bias mitigation, security, and responsible AI usage

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@bencap bencap requested review from jstone-dev and sallybg November 3, 2025 21:06
@bencap bencap merged commit 47f58f7 into release-2025.5.0 Nov 12, 2025
6 checks passed
@bencap bencap deleted the feature/bencap/copilot-onboarding branch November 12, 2025 01:34
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.

2 participants