babel-plugin-add-header-comment
Advanced tools
Comparing version
# How to contribute | ||
We ❤️ pull requests. If you'd like to fix a bug, contribute a feature or | ||
just correct a typo, please feel free to do so, as long as you follow | ||
our [Code of Conduct](https://github.com/Shopify/js-buy-sdk/blob/master/CODE_OF_CONDUCT.md). | ||
our [Code of Conduct](https://github.com/Shopify/babel-plugin-add-header-comment/blob/master/CODE_OF_CONDUCT.md). | ||
@@ -13,3 +13,3 @@ If you're thinking of adding a big new feature, consider opening an | ||
``` | ||
git clone git@github.com:your-username/js-buy-sdk.git | ||
git clone git@github.com:your-username/babel-plugin-add-header-comment.git | ||
``` | ||
@@ -23,6 +23,4 @@ *Note: replace "your-username" with your Github handle* | ||
Run the server: | ||
``` | ||
npm start | ||
``` | ||
Write some features. | ||
Add some tests and make your change. Re-run the tests with: | ||
@@ -34,3 +32,3 @@ ``` | ||
## Examples | ||
See [here](https://github.com/Shopify/js-buy-sdk/blob/master/examples) for our examples. | ||
See [here](https://github.com/Shopify/babel-plugin-add-header-comment/blob/master/examples) for our examples. | ||
@@ -41,12 +39,5 @@ ## Documentation | ||
return value, etc), please ensure the documentation is also updated to | ||
reflect this. The docs live inside the `gh-pages` branch and are hosted | ||
at `shopify.github.io/js-buy-sdk`. | ||
reflect this. Documentation is in the `README.md` if further documentation is needed please communicate via Github Issues. | ||
``` | ||
git checkout -b my-feature-branch gh-pages | ||
script/yuidoc | ||
jekyll serve | ||
``` | ||
The documentation will then be visible at | ||
`http://localhost:4000/js-buy-sdk/index.html` | ||
`http://localhost:4000/babel-plugin-add-header-comment/index.html` |
{ | ||
"name": "babel-plugin-add-header-comment", | ||
"version": "1.0.0", | ||
"version": "1.0.1", | ||
"description": "Will add a header comment (such as license, version info, etc.) to the start of the transpiled code", | ||
@@ -5,0 +5,0 @@ "main": "lib/index.js", |
@@ -58,3 +58,3 @@ # babel-plugin-add-header-comment | ||
- `commentEnd`- This is a string which describes how the comment is ended/closed. For example if you'd like your comment to end with `COMMENT END*/` pass in `'COMMENT END'`. Default value: `'\n*'` | ||
- `commentLineStart`- A string which is the leading charachter before a comment. Default value: `'* '`; | ||
- `commentLineStart`- A string which is the leading charachter before a comment. Default value: `'* '` | ||
@@ -61,0 +61,0 @@ |
12734
0.06%