Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Synced changes from new-docs to CONTRIBUTING.md #1906

Closed
wants to merge 385 commits into from

Conversation

dangreenisrael
Copy link
Member

PR Reference: #1886

What I did

Synced CONTRIBUTING.md with updated in new-docs branch

How to test

N/A: Just added docs

Josh Callender and others added 30 commits August 28, 2017 12:49
A CLI for running specific tests suites, like bootstrap CLI
….0.0

Add dependencies.yml for dependencies.io
Hypnosphi and others added 19 commits September 23, 2017 01:00
Remove greenkeeper & travis
ADD BCH & Slack & opencollective
addon-links: add `LinkTo` component, and `hrefTo` function
# Conflicts:
#	CHANGELOG.md
#	CONTRIBUTING.md
#	addons/actions/package.json
#	addons/centered/package.json
#	addons/comments/package.json
#	addons/events/package.json
#	addons/graphql/package.json
#	addons/info/package.json
#	addons/knobs/package.json
#	addons/links/package.json
#	addons/notes/package.json
#	addons/options/package.json
#	addons/storyshots/package.json
#	app/react-native/package.json
#	app/react/package.json
#	app/vue/package.json
#	lerna.json
#	lib/addons/package.json
#	lib/channel-postmessage/package.json
#	lib/channel-websocket/package.json
#	lib/channels/package.json
#	lib/cli/package.json
#	lib/codemod/package.json
#	lib/components/package.json
#	lib/ui/package.json
CLI: Use actions in sample stories for vue + fix them in SFC_VUE template
@codecov
Copy link

codecov bot commented Sep 28, 2017

Codecov Report

Merging #1906 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1906   +/-   ##
=======================================
  Coverage   21.31%   21.31%           
=======================================
  Files         257      257           
  Lines        5737     5737           
  Branches      691      691           
=======================================
  Hits         1223     1223           
+ Misses       3989     3974   -15     
- Partials      525      540   +15
Impacted Files Coverage Δ
app/react/src/server/config/babel.js 0% <0%> (-100%) ⬇️
app/react/src/server/babel_config.js 0% <0%> (-77.42%) ⬇️
...es__/update-addon-info/update-addon-info.output.js 0% <0%> (ø) ⬆️
...rc/modules/ui/components/left_panel/text_filter.js 30.98% <0%> (ø) ⬆️
.../src/manager/containers/CommentsPanel/dataStore.js 34.97% <0%> (ø) ⬆️
...res__/update-addon-info/update-addon-info.input.js 0% <0%> (ø) ⬆️
app/react-native/src/bin/storybook-build.js 0% <0%> (ø) ⬆️
app/react/src/server/utils.js 53.57% <0%> (ø) ⬆️
...codemod/src/transforms/update-organisation-name.js 40.62% <0%> (ø) ⬆️
app/vue/src/server/utils.js 0% <0%> (ø) ⬆️
... and 18 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3468f58...ce3b0cb. Read the comment docs.

CONTRIBUTING.md Outdated
This will watch files and transpile in watch mode.
- node
- yarn
- @storybook/cli
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not really needed

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ storybook / cli or the whole prerequisites section?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The cli package. You either use example app, or your own, which already has storybook

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

CONTRIBUTING.md Outdated
> It's pretty important to create a very simple sample project like above.
> Otherwise some of the functionality won't work because of linking.
1. `yarn bootstrap`
2. At the prompt: `a`, `enter`, `y`, `enter` ( `a` selects all (fully bootstrap) and `y` is to confirm)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a shortcut for it: yarn bootstrap --all

CONTRIBUTING.md Outdated
cd my-demo-app
getstorybook
```
This method is slow, and if you are reading this tutorial you probably don't want to do it
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"if you are reading this tutorial" doesn't apply here

CONTRIBUTING.md Outdated
```
### Working with the kitchen sink apps

Within the examples folder of the Storybook repo, you will find kitchen sink examples of storybook implementations for the various platforms that storybook supports.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please put examples in backticks

@Hypnosphi
Copy link
Member

Hypnosphi commented Sep 28, 2017

Please rebase it on release/3.3 branch (note that there will be some duplication)

Hypnosphi and others added 3 commits September 29, 2017 02:46
# Conflicts:
#	CHANGELOG.md
#	addons/actions/package.json
#	addons/comments/package.json
#	addons/info/package.json
#	addons/storyshots/package.json
#	app/react-native/package.json
#	app/react/package.json
#	app/vue/package.json
#	examples/cra-kitchen-sink/src/stories/index.js
#	lerna.json
#	lib/ui/package.json
@dangreenisrael
Copy link
Member Author

New PR (to new-docs) #1911

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.