Skip to content

docs: add Copilot instructions - #42

Merged
EndlessTrax merged 2 commits into
mainfrom
docs/add-copilot-instructions
Jul 21, 2026
Merged

docs: add Copilot instructions#42
EndlessTrax merged 2 commits into
mainfrom
docs/add-copilot-instructions

Conversation

@EndlessTrax

@EndlessTrax EndlessTrax commented Jul 21, 2026

Copy link
Copy Markdown
Owner

This pull request adds comprehensive documentation for the Python Template Snippets VS Code extension in the .github/copilot-instructions.md file. The new documentation explains the project structure, snippet conventions, available commands, release process, and commit guidelines, providing clear instructions for maintainers and contributors.

Documentation improvements:

  • Added a detailed overview of the project structure, including how snippet catalogs are registered and used in package.json.
  • Documented conventions for organizing and naming snippet entries, including prefix namespaces and placeholder usage.
  • Provided instructions for validating snippet catalogs, building the VSIX package, and the release workflow.
  • Clarified release responsibilities and the requirement for matching tag and package.json versions.
  • Established strict guidelines for commit and pull request titles using Conventional Commits.

Summary

  • add repository-specific Copilot instructions for snippet changes, validation, releases, and contribution titles
  • document the strict Conventional Commits requirement for commit and pull request titles

EndlessTrax and others added 2 commits July 20, 2026 21:24
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Adds repository-specific GitHub Copilot instructions tailored to this project’s reality as a declarative VS Code snippets extension (not a Python runtime), including snippet-catalog conventions, local validation/packaging commands, release safeguards, and Conventional Commits requirements.

Changes:

  • Add a new .github/copilot-instructions.md detailing project structure and snippet authoring conventions.
  • Document practical validation commands (JSON parse + vsce packaging) that reflect the repo’s lack of npm scripts/tests.
  • Codify release/tag safeguards and Conventional Commits requirements for commits and PR titles.

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

@EndlessTrax
EndlessTrax merged commit 9bd3f87 into main Jul 21, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Updated docs!

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants