GitHub/storybook
1
0
Fork 0
mirror of https://github.com/storybookjs/storybook.git synced 2025-03-28 05:10:17 +08:00
Code Issues Packages Projects Releases Wiki Activity
storybook/CONTRIBUTING.md
Arunoda Susiripala 052ad95817 Implement Mantra Architecture (#165) 
* Add preview container in preview module.

* Update comments.

* Implement preview module.

* Add component tests.

* Add tests for actions.

* Add container tests.

* Write tests for reducers.

* Fix lint issues.

* Add tests for init_pagebus

* Add base ui model with the layout.

* Fix the reducer.

* Add select story pageBus event.

* Update some test cases/

* Implement basic communication with the preview iframe.

* Move actions to a common place.

* Clean mantra reducers.

* Integrated initial leftPanel.

* Implement story filter

* Add initial ActionLogger.

* Add actions grouping.

* Fix lint issues.

* Implement initial routing.
This version lacks, back button support.

* Handle back button properly with routing.

* Add keyboard shortcut support.

* Add responsive tags.

* Move all the admin dependencies to the dev env.
So, end user doesn't need to download the stuff
we use inside the manager.

* Optimize dev build with enabling webpack
when developing the manager.

* Update CONTRIBUTING.md to support the new build environment.

* Add proper support for production build.

* Introduce the api module.

* Add initial docs.

* Add keyboard shortcut help dialog.

* Fix lint issues.

* Fix some missing tests.

* Add tests for actions.

* Write tests for action logger.

* Add tests for layout

* Add tests for left_panel.header.

* Add tests for left_panel.text_filter

* Add tests for left_panel.stories

* Complete tests for the left panel component.

* Simplyfy the container code by implementing the reduxComposer.

* Add container tests.

* Add ui reducer tests.

* Add tests for handle key events

* Add tests to handle_routing.

* Add filters tests

* Add tests for reduxComposer

* Add tests for reduxComposer

* Use a unique Id for the action.id.
We need to support unique id for the action id since now
it's possible to reload the preview iframe.
So, if we use a number from 0, there's a chance for
duplicate ids.

* Update docs.

* Update docs.

* Add manager.js

* Move redux and keycode to dependencies.
2016-05-05 14:26:52 +05:30

1.5 KiB
Raw Blame History

Contributing to React Storybook

We welcome you help to make React Storybook better. This document will help to streamline the contributing process and save everyone's precious time.

Issues

No software is bug free. So, if you got an issue, follow these steps:

  • Check the Known Issues list.
  • Search the issue list for current and old issues.
  • If non of that is helping, create an issue with with following information:
    • Clear title (make is shorter if possible).
    • Describe the issue in clear language.
    • Share error logs, screenshots and etc.
    • To speed up the issue fixing process, send us a sample repo with the issue you faced.

Pull Requests (PRs)

We welcome your contributions. There are many ways you can help us. This is few of those ways:

  • Fix typos and add more documentation.
  • Try to fix some bugs.
  • Work on enhancements and new features.
  • Add more tests (specially for the UI).

Before you submit a new PR, make you to run npm test. Do not submit a PR if tests are failing. If you need any help, create an issue and ask.

Development Guide

Read this: How Storybook Works.