figspec

Unofficial static Figma frame/file viewer available as HTML CustomElement

  1. 1
  2. 2
  3. 3
  4. 4
  5. 5
  6. 6
  7. 7
  8. 8
  9. 9
  10. 10
  11. 11
  12. 12
  13. 13
  14. 14
  15. 15
  16. 16
  17. 17
  18. 18
  19. 19
  20. 20
  21. 21
  22. 22
  23. 23
  24. 24
  25. 25
  26. 26
  27. 27
  28. 28
  29. 29
  30. 30
  31. 31
  32. 32
  33. 33
  34. 34
  35. 35
  36. 36
  37. 37
  38. 38
  39. 39
  40. 40
  41. 41
  42. 42
  43. 43
  44. 44
  45. 45
  46. 46
  47. 47
  48. 48
  49. 49
  50. 50
  51. 51
  52. 52
# Contribution guidelines

## Issues

### Reporting bugs

Please write a clear and concise description with short title.
Codes to reproduce such as a sample repository or a link for an online playground (e.g. CodeSandbox) would be helpful.

### Requesting features

Instead of simply describing the feature, I recommend you to write down a problem you facing and/or use-cases.
These things help us discussing/implementing the feature and make your feature request more appealing.

## Pull Requests

### Submitting a Pull Request

Please keep a Pull Request simple. Don't mix many things into one PR.
We'll request you to break down your PR into small ones if required.

## Development guide

### Requirements

- Node.js >= Maintenance LTS (If you have an NVM, just do `nvm install` or `nvm use` at the root of the repository)
- Yarn

### Bootstraping

```sh
$ yarn

# or "yarn install" if you prefer...
```

### Building packages

You can compile TS files via `yarn build`.
But you won't use the command so often because our development is basically done on Storybook.

```sh
$ yarn build

# to start Storybook
$ yarn storybook
```

### Helper scripts

Packages inside `scripts/` directory is only for our development, not meant to be published to a package registory.
See README on each directory for more details.