Add comprehensive GitHub Copilot instructions for DeviceKit development workflow#454
Add comprehensive GitHub Copilot instructions for DeviceKit development workflow#454
Conversation
|
@Zandor300 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs. I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review. |
Generated by 🚫 Danger |
|
Some instructions for you to add to the repository for you to use in the future: File Source/Device.generated.swift may never be edited directly. We always apply changes to Source/Device.swift.gyb and then run the following command to generate the Device.generated.swift file: ./Utils/gyb --line-directive '' -o ./Source/Device.generated.swift ./Source/Device.swift.gybSo everytime you commit, you should run that right before to update the Device.generated.swift file with your gyb changes. |
…flows Co-authored-by: Zandor300 <6069593+Zandor300@users.noreply.github.com>
Updated the copilot instructions to use the correct gyb command and added critical rules about never editing Device.generated.swift directly. The instructions now emphasize using |
This PR adds a comprehensive
.github/copilot-instructions.mdfile that provides detailed guidance for GitHub Copilot and developers working with the DeviceKit codebase.Key Features Added
Platform Requirements & Limitations
Critical Code Generation Rules
Device.generated.swiftdirectly./Utils/gyb --line-directive '' -o ./Source/Device.generated.swift ./Source/Device.swift.gybComplete Development Workflow
Device.generated.swiftValidation & Testing Scenarios
Time Expectations & Performance
Troubleshooting & Common Issues
Developer Workflow Patterns
The instructions follow an imperative tone as requested and include validation status indicating which commands were verified on Linux vs. those requiring macOS/Xcode. This ensures developers and Copilot have accurate, actionable guidance for working effectively with the DeviceKit codebase.
Fixes #453.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.