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

Make sure each plugin has an example #1023

Closed
hzoo opened this issue Dec 1, 2016 · 4 comments
Closed

Make sure each plugin has an example #1023

hzoo opened this issue Dec 1, 2016 · 4 comments

Comments

@hzoo
Copy link
Member

hzoo commented Dec 1, 2016

cc @existentialism

everything in https://github.com/babel/babel.github.io/tree/master/docs/plugins

{% include package_readme.html %}

links to the readme in https://github.com/babel/babel/tree/master/packages such as https://github.com/babel/babel/tree/master/packages/babel-plugin-transform-es2015-arrow-functions

Meaning make sure it has some kind of in/out example code + maybe a REPL link if it makes sense. Same with each option if it's helpful

We should also probably make sure the format of each readme is consistent (in/out, install, usage, options)

@lukyth
Copy link
Contributor

lukyth commented Dec 2, 2016

I'm wondering what should we do if there's another information on a README in babel.github.io other than In/Out, Install, Usage, and Options.

For example, there is References on transform-object-rest-spread, should we move that section into the package's README (like babel/babel#4930) or should we just leave it on the website?

@hzoo
Copy link
Member Author

hzoo commented Dec 3, 2016

References should be included if possible yes! If it's a transform it could link to the spec, or if it's a proposal link to that

@nitin42
Copy link
Contributor

nitin42 commented Mar 6, 2017

babel/babel#5393

@stale stale bot added the stale label Jun 12, 2017
@stale
Copy link

stale bot commented Jun 12, 2017

This issue has been automatically marked as stale because it has not had recent activity 😴. It will be closed if no further activity occurs. Thank you for your contributions 👌!

@stale stale bot closed this as completed Jun 20, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants