Add Copilot setup instructions and workflow for effective collaboration
This PR implements the necessary setup files to enable GitHub Copilot to effectively collaborate on the Figma Batch Styler project by providing comprehensive environment configuration and architectural guidance.
Changes Made
🔧 GitHub Workflow (.github/workflows/copilot-setup-steps.yaml)
Added a complete environment setup workflow that configures:
- Node.js 18 with npm caching
- Dependency installation via
npm install - Project build process (with error handling for known issues)
- Project structure and configuration verification
- Ready-to-use environment for Copilot development
📚 Copilot Instructions (.github/copilot-instructions.md)
Created comprehensive technical documentation covering:
- Project Overview: Figma plugin for batch updating text and color styles
- Architecture: Svelte 3.x + TypeScript frontend with Figma Plugin API backend
-
Key Files: Main plugin logic (
code.ts), UI components, build configuration - Development Workflow: Install, build, and development patterns
- Code Style: TypeScript patterns, Svelte reactivity, async Figma API usage
⚠️ Known Issues & Limitations
Critical Build Issue: The project currently fails to build due to a compatibility issue with the svelte-color dependency:
ParseError: Attributes need to be unique
node_modules/svelte-color/Hue.svelte:38
<div class="hue {className}" class:vertical class:horizontal={!vertical}>
<Slider bind:value={sliderValue} value={sliderValue} {vertical} on:input={handle}/>
^
No Test Infrastructure: The project lacks any automated testing, limiting Copilot's ability to validate changes.
Legacy Dependencies: Several deprecated packages may cause future compatibility issues.
🚀 Next Steps
Dev Team Action Required: Please test the Copilot integration by commenting:
@copilot Please try building and testing this project using the new setup workflow and instructions. Let us know what issues you encounter and how well the setup helps you understand the codebase.
This will validate:
- Whether Copilot can navigate the build issues effectively
- How well the instructions guide Copilot's understanding
- What additional guidance may be needed for optimal collaboration
The setup provides Copilot with all necessary context to work with this Figma plugin codebase while being transparent about current limitations.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.
🧙 Sourcery is reviewing your pull request!
Tips and commands
Interacting with Sourcery
-
Trigger a new review: Comment
@sourcery-ai reviewon the pull request. - Continue discussions: Reply directly to Sourcery's review comments.
-
Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it. You can also reply to a
review comment with
@sourcery-ai issueto create an issue from it. -
Generate a pull request title: Write
@sourcery-aianywhere in the pull request title to generate a title at any time. You can also comment@sourcery-ai titleon the pull request to (re-)generate the title at any time. -
Generate a pull request summary: Write
@sourcery-ai summaryanywhere in the pull request body to generate a PR summary at any time exactly where you want it. You can also comment@sourcery-ai summaryon the pull request to (re-)generate the summary at any time. -
Generate reviewer's guide: Comment
@sourcery-ai guideon the pull request to (re-)generate the reviewer's guide at any time. -
Resolve all Sourcery comments: Comment
@sourcery-ai resolveon the pull request to resolve all Sourcery comments. Useful if you've already addressed all the comments and don't want to see them anymore. -
Dismiss all Sourcery reviews: Comment
@sourcery-ai dismisson the pull request to dismiss all existing Sourcery reviews. Especially useful if you want to start fresh with a new review - don't forget to comment@sourcery-ai reviewto trigger a new review!
Customizing Your Experience
Access your dashboard to:
- Enable or disable review features such as the Sourcery-generated pull request summary, the reviewer's guide, and others.
- Change the review language.
- Add, remove or edit custom review instructions.
- Adjust other review settings.
Getting Help
- Contact our support team for questions or feedback.
- Visit our documentation for detailed guides and information.
- Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.