├── .github └── ISSUE_TEMPLATE │ ├── bug_report.md │ └── feature_request.md └── README.md /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug 3 | about: Describe a defect you encountered 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | ### Problem 10 | 11 | Describe the bug in a sentence or two. 12 | 13 | ### Source file to troubleshoot 14 | 15 | Access to the frame/instance(s) that trigger the defect are essential for the plugin maker to troubleshoot the issue. A screenshot of the vague Figma error message is not enough. If possible, provide access to a view-only Figma file – even with JUST the frame or instance in it – by pasting the shared link below or DM'ing Nathan privately in the Specs Plugin Slack (https://join.slack.com/t/eightshapes-specs/shared_invite/zt-1w4k19pj7-viPHKW8045zak64u~lH4yA). 16 | 17 | {Paste link here} 18 | 19 | ### Screenshots 20 | 21 | If possible, paste screenshots from your clipboard, including ideally: 22 | * Current Specs plugin UI settings (if a defect is currently displayed, restart the plugin and screenshot those settings) 23 | * Frame(s)/instance(s) on which the plugin is being run 24 | * Output the plugin produced 25 | * Bug(s) displayed in the plugin's UI 26 | 27 | {Paste screenshots here} 28 | 29 | ### Additional context 30 | 31 | Add any other context about the problem here. 32 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Problem** 11 | Describe the problem you are trying to solve, such as "The plugin doesn't enable me to..." 12 | 13 | **Possible solution** 14 | Clearly and concisely describe one – or more – potential ways the plugin could help you solve the problem. 15 | 16 | **Additional context** 17 | Add any other context or background to support your need. 18 | 19 | **Screenshots** 20 | Paste screenshot(s) from your clipboard of examples you'd like to see, including mockups of enhanced plugin output. 21 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # EightShapes Specs 2 | 3 | ![EightShapes Specs Cover Art](https://github.com/EightShapes/specs-plugin/assets/1165904/f66d12ad-5c46-45cc-9f49-7c398feba7cf) 4 | 5 | Welcome to the EightShapes Specs Figma plugin repository. This repository's purpose is publish documentation about the plugin and serve as a public forum for plugin authors and users to submit defects and feature ideas and monitor their status. 6 | 7 | ## Plugin features 8 | 9 | The plugin automates the production design specifications based on selected Figma frames, component instances, components and/or component sets. 10 | 11 | To learn more, visit the [specs plugin](https://www.specsplugin.com/) site. 12 | 13 | ## Support and discussion 14 | 15 | * [Slack community](https://join.slack.com/t/eightshapes-specs/shared_invite/zt-1w4k19pj7-viPHKW8045zak64u~lH4yA), to discuss plugin features with the community and the plugin creator 16 | * [Github issues](https://github.com/EightShapes/specs-plugin/issues) to browse the backlog of pending requests and existing defects 17 | * [Create new issue](https://github.com/EightShapes/specs-plugin-feedback/issues/new/choose) to submit a defect or request a feature 18 | 19 | ## About the plugin 20 | 21 | The plugin was created by [Nathan Curtis](https://twitter.com/nathanacurtis). Foundational support to build the plugin UI was provided by [Kevin Powell](https://twitter.com/kevinmpowell). 22 | 23 | The plugin's origin is described in the Medium articles [The EightShapes Specs Figma Plugin](https://medium.com/eightshapes-llc/the-eightshapes-specs-figma-plugin-2892f21adc96) and [Component Specifications](https://medium.com/eightshapes-llc/component-specifications-1492ca4c94c). 24 | 25 | The plugin code is maintained in a [separate, private repository](https://github.com/EightShapes/esds-specs). Please [contact @nathanacurtis](https://github.com/nathanacurtis) for details. 26 | --------------------------------------------------------------------------------