Thanks for your consideration on contributing to Aesop for Storybook! Each contribution helps make using Aesop for Storybook a better experience for everyone.
Aesop for Storybook is an open source project and thrives on community contributions! These contributions can come in many forms-- anywhere from improving documentation to submitting bug reports and feature requests.
We are also open to any code contributions that can be assimilated into the extension itself! For inspiration, take a look at our roadmap below.
First time contributing to an open source project? You can learn more here!
Now, you’re ready to contribute.
If you find an area where you want to contribute, please fork the repository and create a branch with a descriptive name.
A good branch name would be (where issue #234 is the ticket you're working on):
git checkout -b 234-add-treeview
Afterwards, if you feel like this contribution might help the project, feel free to send a pull request.
After forking and cloning the repository, open the folder in VS Code. Make sure that your root directory is the Aesop folder. Once there, you can launch the VS Code built-in debugger using the shortcut F5. You can learn more about this here
After pressing F5, VS Code will build the extension and launch an Extension Development Host window as seen below. In order to test the extension, you will need to open a Storybook project as your root directory in VS Code, making sure that Storybook is a dependency in your node modules folder.
Once you've gotten everything set up, you can launch Aesop's webview by selecting 'Aesop Awaken' from the command palette (CTRL+SHIFT+P) or using the shortcut (CTRL K+A).
You can also make use of VS Code's Webview Developer tools by selecting them in the command palette.
Closing the Extension Development Host will also close all Aesop child processes and Storybook instances run within it.
However, be mindful. The Extension Development Host will run the LAST WORKING VERSION of the extension. This means if you've introduced breaking changes, the version you're seeing might not be running the code you think. To get around this, we usually implement a sort of hack-around solution by including a text counter as an HTML element within the web-view, changing it as we iterate. ...There's probably a better solution to this, but it's been working thus far.
If you find a security vulnerability, please do NOT open an issue. Send a message to AesopStorybook@gmail.com instead.
When filing an issue, make sure to answer these questions:
- What version of VS Code are you using?
- What version of Storybook are you using for your project?
- What operating system and processor architecture are you using?
- What did you do? Please also include the following details: a. Was Storybook currently running before you launched the extension command? b. Did you have a port flag defined in your package.json storybook script?
- What did you expect to see?
- What did you see instead?
Aesop’s philosophy is to provide a seamless developer experience for using Storybook within VS Code. We want to keep the extension as light weight and easy to use as possible out of the box.
If you think of any feature that you might like to see in Aesop for Storybook, please open an issue on our issues list on Github describing the feature you’d like to see, why you need it, and how it should work.
-
Fine-tuning windows compatibility for all developer workflows a. Storybook is already running w/ port flag defined in npm run storybook script(working) b. Storybook is already running w/o port flag defined (working) c. Storybook is not currently running w/ port flag defined (not working) d. Storybook is not currently running w/o port flag defined (not working)
-
Add cross-platform testing.
-
Separate Storybook Manager from Preview iframe, replacing it with a vscode tree-view allowing you to interact with the Storybook preview from within the vscode explorer menu.
Under Construction
Under Construction