Skip to content

Commit

Permalink
Merge branch 'release/3.3' into channel-onPeer
Browse files Browse the repository at this point in the history
  • Loading branch information
danielduan committed Nov 15, 2017
2 parents c9f21e1 + 9d18407 commit 005fb0f
Show file tree
Hide file tree
Showing 359 changed files with 8,581 additions and 3,431 deletions.
2 changes: 1 addition & 1 deletion .circleci/config.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
defaults: &defaults
working_directory: /tmp/storybook
docker:
- image: circleci/node:latest
- image: circleci/node:8.9

version: 2
dependencies:
Expand Down
1 change: 1 addition & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ module.exports = {
'jsx-a11y/accessible-emoji': ignore,
'jsx-a11y/href-no-hash': ignore,
'jsx-a11y/label-has-for': ignore,
'jsx-a11y/click-events-have-key-events': error,
'jsx-a11y/anchor-is-valid': [warn, { aspects: ['invalidHref'] }],
'react/no-unescaped-entities': ignore,
},
Expand Down
18 changes: 10 additions & 8 deletions .github/stale.yml
Original file line number Diff line number Diff line change
@@ -1,26 +1,28 @@
# Number of days of inactivity before an issue becomes stale
daysUntilStale: 85
daysUntilStale: 45
# Number of days of inactivity before a stale issue is closed
daysUntilClose: 5
daysUntilClose: 15
# Issues with these labels will never be considered stale
exemptLabels:
- bug
- 'help wanted'
- todo
- ready
- 'in progress'
- 'do not merge'
- 'needs review'
- 'high priority'

# Label to use when marking an issue as stale
staleLabel: inactive
# Comment to post when marking an issue as stale. Set to `false` to disable
markComment: >
Hi everyone! Seems like there hasn't been much going on in this issue lately.
If there are still questions, comments, or bugs, please feel free to continue
the discussion. We do try to do some housekeeping every once in a while so
inactive issues will get closed after 90 days. Thanks!
the discussion. Unfortunately, we don't have time to get to every issue. We
are always open to contributions so please send us a pull request if you would
like to help. Inactive issues will be closed after 60 days. Thanks!
# Comment to post when closing a stale issue. Set to `false` to disable
closeComment: >
Hey there, it's me again! I am going to help our maintainers close this issue
so they can focus on development efforts instead. If the issue mentioned is
Hey there, it's me again! I am going close this issue to help our maintainers
focus on the current development roadmap instead. If the issue mentioned is
still a concern, please open a new ticket and mention this old one. Cheers
and thanks for using Storybook!
84 changes: 84 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,46 @@
# 3.3.0-alpha.3

2017-November-07

#### Features

- Add angular support: Storybook for Angular [#1474](https://github.com/storybooks/storybook/pull/1474)
- Fix addon Knobs: add array in Object PropTypes [#2227](https://github.com/storybooks/storybook/pull/2227)
- Adds error when storyshots finds no stories [#2079](https://github.com/storybooks/storybook/pull/2079)
- Add addon background to monorepo [#2220](https://github.com/storybooks/storybook/pull/2220)
- Add ability to parse line breaks into <br/> for Docgen descriptions [#2053](https://github.com/storybooks/storybook/pull/2053)

#### Bug Fixes

- Move LinkTo component to a separate `addon-links/react` endpoint [#2239](https://github.com/storybooks/storybook/pull/2239)
- Fix Array Knob deserialization [#2217](https://github.com/storybooks/storybook/pull/2217)
- Return the test in storyshots to respect promises. [#2218](https://github.com/storybooks/storybook/pull/2218)
- Knobs refactor accidentally removed select [#2210](https://github.com/storybooks/storybook/pull/2210)
- Add HMR to other RN app templates [#2213](https://github.com/storybooks/storybook/pull/2213)
- Autoload all `*.stories.js` files in cli templates [#2195](https://github.com/storybooks/storybook/pull/2195)
- Fix info upgrade codemod failing when optional description string is not supplied [#2138](https://github.com/storybooks/storybook/pull/2138)
- Fix `flex-basis` of `DownPanel` content div [#2126](https://github.com/storybooks/storybook/pull/2126)

#### Documentation

- Updated local test documentation [#2224](https://github.com/storybooks/storybook/pull/2224)
- Add state addon to the addons page [#2012](https://github.com/storybooks/storybook/pull/2012)
- Add community addon to add the ability to customize styles in the story preview area [#2007](https://github.com/storybooks/storybook/pull/2007)
- Add Figma addon to community supported section [#2009](https://github.com/storybooks/storybook/pull/2009)
- Update storybook-router description in the addon gallery. [#1991](https://github.com/storybooks/storybook/pull/1991)

#### Maintenance

- FIX `yarn test` & selecting only core [#2219](https://github.com/storybooks/storybook/pull/2219)
- CLI test: always remove `run` directory before exiting [#2201](https://github.com/storybooks/storybook/pull/2201)
- Bot for closing old issues [#2186](https://github.com/storybooks/storybook/pull/2186)

#### Dependency Upgrades

- Update react-native from 0.43.4 to 0.49.3 in app/react-native [#1971](https://github.com/storybooks/storybook/pull/1971)
- React-Native - Docs - Add Issues section for Android Emulator [#2078](https://github.com/storybooks/storybook/pull/2078)
- Upgrade eslint-config-airbnb and make it pass [#2212](https://github.com/storybooks/storybook/pull/2212)

# 3.3.0-alpha.2

2017-October-03
Expand Down Expand Up @@ -100,6 +143,47 @@
- Update eslint-plugin-jest to the latest version 🚀 [#1795](https://github.com/storybooks/storybook/pull/1795)
- Update lerna to the latest version 🚀 [#1768](https://github.com/storybooks/storybook/pull/1768)

# 3.2.15

2017-November-10

#### Features

- Optimizing for iphone x [#2260](https://github.com/storybooks/storybook/pull/2260)
- Fix accessibility warnings [#2270](https://github.com/storybooks/storybook/pull/2270)

#### Bug Fixes

- Fix propTypes in addon-background [#2279](https://github.com/storybooks/storybook/pull/2279)
- Addon-info: allow duplicate displayNames [#2269](https://github.com/storybooks/storybook/pull/2269)
- Fix browser navigation [#2261](https://github.com/storybooks/storybook/pull/2261)

#### Maintenance

- Fixes to build scripts for Windows. [#2051](https://github.com/storybooks/storybook/pull/2051)
- Update dependencies.yml to include batch updates for docs dependencies [#2252](https://github.com/storybooks/storybook/pull/2252)

#### Dependency Upgrades

<details>
<summary>
11 PRs
</summary>

- Update 4 dependencies from npm [#2267](https://github.com/storybooks/storybook/pull/2267)
- Update 8 dependencies from npm [#2262](https://github.com/storybooks/storybook/pull/2262)
- Update 3 dependencies from npm [#2257](https://github.com/storybooks/storybook/pull/2257)
- Update babel-eslint in / from 8.0.1 to 8.0.2 [#2253](https://github.com/storybooks/storybook/pull/2253)
- 3 packages updated by dependencies.io [#2251](https://github.com/storybooks/storybook/pull/2251)
- Update devDependencies [#2232](https://github.com/storybooks/storybook/pull/2232)
- Update react-textarea-autosize to 5.1.0 [#2233](https://github.com/storybooks/storybook/pull/2233)
- Update insert-css to 2.0.0 [#2234](https://github.com/storybooks/storybook/pull/2234)
- Update file-loader to 1.1.5 [#2236](https://github.com/storybooks/storybook/pull/2236)
- Update read-pkg-up to 3.0.0 [#2237](https://github.com/storybooks/storybook/pull/2237)
- Update react-modal to 3.1.0 [#2238](https://github.com/storybooks/storybook/pull/2238)

</details>

# 3.2.14

2017-November-01
Expand Down
46 changes: 46 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at ndelangen@me.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
51 changes: 42 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,15 +47,35 @@ This command will list all the suites and options for running tests.
yarn test
```

_Note that in order to run the tests fro ReactNative, you must have bootstrapped with ReactNative enabled_
The options for running tests can be selected from the cli or be passed to `yarn test` with specific parameters. Available modes include `--watch`, `--coverage`, and `--runInBand`, which will respectively run tests in watch mode, output code coverage, and run selected test suites serially in the current process.

You can also pick suites from CLI:
You can use the `--update` flag to update snapshots or screenshots as needed.

```sh
yarn test --core
```
You can also pick suites from CLI. Suites available are listed below.

##### Core & React & Vue Tests

`yarn test --core`

This option executes test from `<rootdir>/app/react`, `<rootdir>/app/vue`, and `<rootdir>/lib`
Before the tests are ran, the project must be bootstrapped with core. You can accomplish this with `yarn bootstrap --core`

##### React-Native example Tests

`yarn test --reactnative`

This option executes tests from `<rootdir>/app/react-native`
Before these tests are ran, the project must be bootstrapped with the React Native example enabled. You can accomplish this by running `yarn bootstrap --reactnative`

##### Integration Tests (Screenshots of running apps)

`yarn test --integration`

This option executes tests from `<rootdir>/integration`
In order for the snapshot-integration tests to be executed properly, examples being tested must be running on their defaults ports, as declared in `integration/examples.test.js`

Puppeteer is used to launch and grab screenshots of example pages, while jest is used to assert matching images.

In order to run ALL unit tests, you must have bootstrapped the react-native

#### 2b. Run e2e tests for CLI

Expand Down Expand Up @@ -116,6 +136,19 @@ If you follow that process, you can then link to the github repository in the is
**NOTE**: If your issue involves a webpack config, create-react-app will prevent you from modifying the _app's_ webpack config, however you can still modify storybook's to mirror your app's version of storybook. Alternatively, use `yarn eject` in the CRA app to get a modifiable webpack config.
### Updating Tests
Before any contributes are submitted in a PR, make sure to add or update meaningful tests. A PR that has failing tests will be regarded as a “Work in Progress” and will not be merged until all tests pass.
When creating new unit test files, the tests should adhere to a particular folder structure and naming convention, as defined below.
```sh
#Proper naming convention and structure for js tests files
+-- parentFolder
| +-- [filename].js
| +-- [filename].test.js
```
## Pull Requests (PRs)
We welcome your contributions. There are many ways you can help us. This is few of those ways:
Expand Down Expand Up @@ -147,11 +180,11 @@ Once you've helped out on a few issues, if you'd like triage access you can help
We use the following label scheme to categorize issues:
- **type** - `bug`, `feature`, `question / support`, `discussion`, `greenkeeper`, `maintenance`.
- **type** - `bug`, `feature`, `question / support`, `discussion`, `dependencies`, `maintenance`.
- **area** - `addon: x`, `addons-api`, `stories-api`, `ui`, etc.
- **status** - `needs reproduction`, `needs PR`, `in progress`, etc.
All issues should have a `type` label. `bug`/`feature`/`question`/`discussion` are self-explanatory. `greenkeeper` is for keeping package dependencies up to date. `maintenance` is a catch-all for any kind of cleanup or refactoring.
All issues should have a `type` label. `bug`/`feature`/`question`/`discussion` are self-explanatory. `dependencies` is for keeping package dependencies up to date. `maintenance` is a catch-all for any kind of cleanup or refactoring.
They should also have one or more `area`/`status` labels. We use these labels to filter issues down so we can easily see all of the issues for a particular area, and keep the total number of open issues under control.
Expand Down Expand Up @@ -327,4 +360,4 @@ npm run publish -- --concurrency 1 --force-publish=*
# update the release page
open https://github.com/storybooks/storybook/releases
```
```
1 change: 0 additions & 1 deletion MIGRATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,6 @@ The new package names are:
| `@kadira/storybook-addon-links` | `@storybook/addon-links` |
| `@kadira/storybook-addon-info` | `@storybook/addon-info` |
| `@kadira/storybook-addon-knobs` | `@storybook/addon-knobs` |
| `@kadira/storybook-addon-comments` | `@storybook/addon-comments` |
| `@kadira/storybook-addon-notes` | `@storybook/addon-notes` |
| `@kadira/storybook-addon-options` | `@storybook/addon-options` |
| `@kadira/storybook-addon-graphql` | `@storybook/addon-graphql` |
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,8 @@ For full documentation on using Storybook visit: [storybook.js.org](https://stor

- [Storybook for react](app/react) - Storybook for React components
- [Storybook for vue](app/vue) - Storybook for Vue components
- [Storybook for react-native](app/react-native) - Storybook for React components
- [Storybook for angular](app/angular) - Storybook for Angular components
- [Storybook for react-native](app/react-native) - Storybook for React-Native components

### Sub Projects

Expand Down
61 changes: 24 additions & 37 deletions ROADMAP.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,23 @@

## Table of contents

- [New features](#new-features)
- [Responsive + multi-device viewports preview.](#responsive--multi-device-viewports-preview)
- [Automatic story detection](#automatic-story-detection)
- [Theme ability and override core UI components](#theme-ability-and-override-core-ui-components)
- [Add a playground addon](#add-a-playground-addon)
- [See multiple (or all) stories in 1 preview.](#see-multiple-or-all-stories-in-1-preview)
- [Deeper level hierarchy](#deeper-level-hierarchy)
- [Supporting other frameworks and libraries](#supporting-other-frameworks-and-libraries)
- [Vue](#vue)
- [Angular](#angular)
- [Webcomponents](#webcomponents)
- [Polymer](#polymer)
- [Aurelia](#aurelia)
- [Breaking changes](#breaking-changes)
- [Addon API](#addon-api)
- [API for adding stories](#api-for-adding-stories)
- [Documentation](#documentation)
- [Better design](#better-design)
- [Record videos and write blog post on how to use, tweak & develop storybook](#record-videos-and-write-blog-post-on-how-to-use-tweak--develop-storybook)
* [New features](#new-features)
+ [Responsive + multi-device viewports preview.](#responsive--multi-device-viewports-preview)
+ [Automatic story detection](#automatic-story-detection)
+ [Theme ability and override core UI components](#theme-ability-and-override-core-ui-components)
+ [Add a playground addon](#add-a-playground-addon)
+ [See multiple (or all) stories in 1 preview.](#see-multiple--or-all--stories-in-1-preview)
* [Supporting other frameworks and libraries](#supporting-other-frameworks-and-libraries)
+ [Angular](#angular)
+ [Polymer & Webcomponents](#polymer---webcomponents)
+ [Aurelia](#aurelia)
+ [Ember](#ember)
* [Breaking changes](#breaking-changes)
+ [Addon API](#addon-api)
+ [API for adding stories](#api-for-adding-stories)
* [Documentation](#documentation)
+ [Better design](#better-design)
+ [Record videos and write blog post on how to use, tweak & develop storybook](#record-videos-and-write-blog-post-on-how-to-use--tweak---develop-storybook)

## New features

Expand Down Expand Up @@ -56,13 +54,6 @@ It's quite common to see users write a single story, with a wrapper components a
We plan to add a second mode to storybook that will allow you to see all stories in 1 preview.
That way you can write your stories how they are best, and preview them how you like.

### Deeper level hierarchy

A very long standing issue is about "what about larger styleguides?". Some styleguides have lots and lots of components.
At some point is becomes unmaintainable if you do not group them somehow.
Storybook's UI is not exactly setup for very large styleguides, right now.
But we are going to add a way of defining groups! And develop a UI that allows you to quickly navigate to other groups / stories.

## Supporting other frameworks and libraries

We believe in the power of react, and think it's the right choice for a lot of projects.
Expand All @@ -71,25 +62,21 @@ Unfortunately if you choose anything other then React or React-Native you can no

We want you to be able to use storybook with the framework / library of your choice.

### Vue

Storybook for Vue is currently in alpha release, it won't be long now!

### Angular

Storybook for Angular is in development.
Storybook for Angular is in alpha and will be included in the 3.3.0 release.

### Webcomponents
### Polymer & Webcomponents

Interested in supporting.
Storybook for Polymer is currently in development, and will support custom elements.

### Polymer
### Aurelia

Interested in supporting, once bower and html-imports are gone.
We're reaching out to the Aurelia maintainers to cooperate on this.

### Aurelia
### Ember

Please contact us if you want this.
We're reaching out to the Ember maintainers to cooperate on this.

## Breaking changes

Expand Down
1 change: 1 addition & 0 deletions addons/a11y/.storybook/addons.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
import '../register';
Loading

0 comments on commit 005fb0f

Please sign in to comment.