Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Nov 12, 2025

Configures GitHub Copilot coding agent with repository-specific conventions and standards per best practices.

Changes

  • Added .github/copilot-instructions.md documenting:
    • 3-tier directory structure: {Language}/{Category}/{Subcategory}/
    • Script placement rules with examples (e.g., Python database backup → Python/automation/backup/)
    • Naming: kebab-case with action verbs (backup-mysql-database.py)
    • Language-specific standards for PowerShell, Python, Bash, JavaScript, Go, Ruby
    • Required documentation templates per language
    • Security rules: no hardcoded credentials, validate inputs, sanitize paths
    • Testing expectations: valid, invalid, and edge cases
    • Git workflow preferences (plain git + web UI for PRs)

Example Convention

#!/usr/bin/env python3
"""
Brief description of the script.

Detailed description of functionality and usage.
"""
# Follow PEP 8, use type hints, include requirements.txt

The instructions enable Copilot to maintain consistency across the 6 supported languages and enforce the repository's organizational structure.

Original prompt

This section details on the original issue you should resolve

<issue_title>✨ Set up Copilot instructions</issue_title>
<issue_description>Configure instructions for this repository as documented in Best practices for Copilot coding agent in your repository.

</issue_description>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI changed the title [WIP] Set up Copilot instructions for repository Add Copilot instructions for repository conventions Nov 12, 2025
Copilot AI requested a review from AprilDeFeu November 12, 2025 01:39
@AprilDeFeu AprilDeFeu marked this pull request as ready for review November 12, 2025 01:41
@AprilDeFeu AprilDeFeu requested review from Copilot and removed request for AprilDeFeu November 12, 2025 01:41
Copy link
Contributor

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 GitHub Copilot coding agent instructions for the Scripts repository, implementing repository-specific conventions and standards as recommended by GitHub's best practices.

Key Changes:

  • Adds comprehensive .github/copilot-instructions.md documenting the repository's 3-tier organizational structure, naming conventions, and coding standards
  • Defines language-specific requirements for PowerShell, Python, Bash, JavaScript, Go, and Ruby scripts
  • Establishes security guidelines and testing expectations for all scripts

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

@AprilDeFeu AprilDeFeu merged commit 4823ac8 into main Nov 12, 2025
12 checks passed
@AprilDeFeu AprilDeFeu deleted the copilot/set-up-copilot-instructions branch November 12, 2025 01:43
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.

✨ Set up Copilot instructions

2 participants