Skip to content

✨ Set up Copilot instructions for AI development guidelines#472

Merged
azu merged 2 commits intomasterfrom
copilot/fix-471
Sep 7, 2025
Merged

✨ Set up Copilot instructions for AI development guidelines#472
azu merged 2 commits intomasterfrom
copilot/fix-471

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Sep 7, 2025

This PR configures GitHub Copilot instructions for the HonKit repository following best practices for AI coding assistants. The instructions provide comprehensive guidance tailored to this Node.js book publishing platform.

What's Added

Created .copilot-instructions.md with detailed guidelines covering:

Project Structure & Setup

  • Monorepo management with Lerna
  • pnpm package management requirements
  • Node.js version specifications
  • Build system configuration

Development Standards

  • TypeScript preferences and code style
  • Prettier & ESLint configuration details
  • Angular commit message conventions
  • Testing and documentation requirements

HonKit-Specific Guidelines

  • Plugin architecture patterns
  • Backward compatibility considerations
  • Performance implications for book generation
  • Security practices for markdown processing

AI Assistant Notes

  • Focus on maintaining project stability
  • Explicit guidance on breaking changes
  • Emphasis on following existing code patterns
  • User workflow impact awareness

The instructions build upon the existing CONTRIBUTING.md while providing AI-specific context for working with this codebase. This will help AI coding assistants understand the project's conventions, architecture, and quality standards when assisting with development.

Fixes #471.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Copilot AI changed the title [WIP] ✨ Set up Copilot instructions ✨ Set up Copilot instructions for AI development guidelines Sep 7, 2025
Copilot AI requested a review from azu September 7, 2025 14:50
@azu azu marked this pull request as ready for review September 7, 2025 16:29
@azu azu merged commit 4948e5e into master Sep 7, 2025
20 checks passed
@azu azu deleted the copilot/fix-471 branch September 7, 2025 16:32
@github-actions github-actions bot mentioned this pull request Sep 7, 2025
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