This directory contains GitHub-specific configuration files for the ESP32 Distance Sensor project.
- copilot-instructions.md - Custom instructions for GitHub Copilot coding agent
- Comprehensive project context and technical guidelines
- ESP32 and ESP-IDF specific best practices
- Hardware-specific considerations and constraints
- Links to detailed prompt snippets in
prompt-snippets/
The prompt-snippets/ directory contains detailed reference documentation:
- esp32-coding-standards.md - ESP32/ESP-IDF coding conventions and patterns
- build-instructions.md - Build, flash, and troubleshooting guides
- development.md - Development workflow and branch management
- commit-message.md - Commit message format and examples
- oft-requirements.md - OpenFastTrack requirements methodology
- actions/ - Reusable GitHub Actions for CI/CD
setup-coding-agent-env/- Environment setup for coding agent and CI
- workflows/ - GitHub Actions workflow definitions
- Pre-commit quality checks (linting, building, testing)
- Automated CI/CD pipelines
GitHub Copilot will automatically use the instructions in copilot-instructions.md when:
- Generating code suggestions in your IDE
- Resolving issues assigned to
@copilot - Reviewing pull requests
- Working on GitHub Copilot Workspace tasks
The instructions provide context about:
- Project architecture and hardware constraints
- Memory management for ESP32 (4MB flash)
- FreeRTOS and ESP-IDF best practices
- Testing, linting, and quality gates
- OpenFastTrack requirements methodology
When contributing to this project:
- Review the copilot-instructions.md to understand project standards
- Use GitHub Copilot with confidence - it's configured for this project
- Follow the quality gates outlined in the instructions
- Reference the prompt snippets for detailed guidance on specific areas
These instructions should be updated when:
- Project architecture changes significantly
- New development tools or practices are adopted
- Hardware or technical constraints change
- New team members need different context
For questions or suggestions about these instructions, open an issue or discussion.