Add AI agent instructions for Checkbox development #2298
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add .github/copilot-instructions.md with comprehensive guidance for AI coding agents working on Checkbox. The instructions cover: - Big picture architecture (checkbox-ng core, providers, packaging) - Provider anatomy and structure (manage.py, bin/, units/, tests/) - Developer workflows (venv setup, provider build/test/validate) - Project conventions (Black formatting, setuptools_scm, signed commits) - Provider code style rules from providers/README.md: - Python: pathlib, .format(), subprocess, argparse, avoid regexes - PXU: avoid nested bash, declare env vars, no Jinja templates - Dependencies: strict avoidance (Ubuntu 18.04+ ESM compatibility) - Integration points (pyproject.toml, manage.py, tox.ini) - Copyable examples for common development tasks This provides AI agents with project-specific knowledge to be immediately productive and follow Checkbox conventions.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive AI agent instructions in .github/copilot-instructions.md to help AI coding assistants understand Checkbox project structure, conventions, and development workflows. The instructions provide guidance on architecture, provider development, testing, code style rules, and common development tasks.
Changes:
- Added
.github/copilot-instructions.mdwith project-specific guidance for AI agents - Covers architecture (checkbox-ng, providers, packaging), developer workflows, testing, conventions, and copyable examples
- References existing documentation sources (CONTRIBUTING.md, providers/README.md) for detailed guidelines
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add .github/copilot-instructions.md with comprehensive guidance for AI coding agents working on Checkbox. The instructions cover:
This provides AI agents with project-specific knowledge to be immediately productive and follow Checkbox conventions.
Description
Resolved issues
Documentation
Tests