Skip to content

Add testing instructions for Figma plugin development to README#16

Merged
mikhin merged 2 commits intomainfrom
copilot/fix-af939332-75c5-4f18-a35a-1d75901c4467
Jul 22, 2025
Merged

Add testing instructions for Figma plugin development to README#16
mikhin merged 2 commits intomainfrom
copilot/fix-af939332-75c5-4f18-a35a-1d75901c4467

Conversation

Copy link
Contributor

Copilot AI commented Jul 21, 2025

This PR adds a comprehensive "Testing the Plugin in Figma" section to the README.md file to help developers test the plugin locally during development.

What's Added

The new section includes:

Setting up the Plugin for Testing

  • Instructions to build the plugin first
  • Requirement to use Figma Desktop (not web version)
  • Step-by-step guide for importing the plugin from manifest.json
  • Details on where the plugin appears in Figma's interface

Running the Plugin

  • How to launch the plugin via menu navigation
  • Keyboard shortcut alternative (Cmd/Ctrl + / and search)

Placement

The section is strategically placed after the "Build" section and before the "Contributing" section, providing a natural flow from building to testing to contributing.

Benefits

This addition will help developers:

  • Quickly get the plugin running in their local Figma environment
  • Understand the difference between web and desktop Figma requirements
  • Know exactly where to find and launch their development plugin
  • Have a complete development workflow from build to test

The instructions are concise but comprehensive, following the existing documentation style in the README.

This pull request was created as a result of the following prompt from Copilot chat.

Add a section to the README.md file that explains how to test the UI plugin in Figma. The section should include:

Testing the Plugin in Figma

Setting up the Plugin for Testing

  1. Build the plugin using the command above to generate the necessary files
  2. Open Figma Desktop (the plugin development requires the desktop version, not the web version)
  3. Import the plugin:
    • Go to Menu → Plugins → Development → Import plugin from manifest...
    • Navigate to your project directory and select the manifest.json file
    • The plugin will appear in your Development section under Plugins

Running the Plugin

  1. Launch the plugin:
    • Go to Menu → Plugins → Development → Polychrom
    • Or use the shortcut Cmd/Ctrl + / and search for "Polychrom"

This section should be added after the "Build" section and before the "Contributing" section in the README.md file.


💡 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.

@mikhin
Copy link
Collaborator

mikhin commented Jul 21, 2025

Well...

Copilot AI changed the title [WIP] Add testing instructions for UI plugin in Figma to README Add testing instructions for Figma plugin development to README Jul 21, 2025
Copilot AI requested a review from mikhin July 21, 2025 15:27
@mikhin mikhin requested a review from Copilot July 21, 2025 15:28
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds comprehensive testing instructions for Figma plugin development to the README.md file, along with several CSS utility class improvements in React components.

  • Addition of "Testing the Plugin in Figma" section with setup and usage instructions
  • Updates to Tailwind CSS classes, replacing separate h- and w- utilities with the more concise size- utility
  • Strategic placement of testing documentation between build and contributing sections

Reviewed Changes

Copilot reviewed 6 out of 7 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
Readme.md Adds complete testing section with plugin setup and running instructions
src/ui/components/SettingsButton.tsx Updates button styling to use size-6 instead of h-6 w-6
src/ui/components/SelectionContent.tsx Updates container div to use size-full instead of h-full w-full
src/ui/components/LayeredColorPreviewIcon.tsx Updates icon container to use size-4 instead of h-4 w-4
src/ui/components/HelpLink.tsx Updates link styling to use size-6 instead of h-6 w-6
src/ui/components/ContrastSample.tsx Partially updates small size variant to use size-9 instead of h-9 w-9

<p
className={clsx(
size === 'small' ? 'h-9 w-9 text-xxs' : 'h-13 w-13 text-base',
size === 'small' ? 'size-9 text-xxs' : 'h-13 w-13 text-base',
Copy link

Copilot AI Jul 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Inconsistent CSS utility class usage. The 'small' size uses 'size-9' while the default case still uses 'h-13 w-13'. For consistency with the other changes in this PR, consider using 'size-13' for the default case as well.

Suggested change
size === 'small' ? 'size-9 text-xxs' : 'h-13 w-13 text-base',
size === 'small' ? 'size-9 text-xxs' : 'size-13 text-base',

Copilot uses AI. Check for mistakes.
@mikhin mikhin force-pushed the copilot/fix-af939332-75c5-4f18-a35a-1d75901c4467 branch from 8c795d1 to 9b5e746 Compare July 22, 2025 08:23
@mikhin mikhin marked this pull request as ready for review July 22, 2025 08:24
@mikhin mikhin merged commit 5e275a0 into main Jul 22, 2025
2 checks passed
@ai
Copy link
Member

ai commented Jul 22, 2025

Thanks!

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.

4 participants