mirror of
https://github.com/bobwen-dev/react-templates
synced 2025-04-12 00:56:39 +02:00
Update markdown files
This commit is contained in:
parent
2cafda386d
commit
4ab5d0f44d
33
CONTRIBUTING.md
Normal file
33
CONTRIBUTING.md
Normal file
@ -0,0 +1,33 @@
|
|||||||
|
# Contributing to React-Templates
|
||||||
|
|
||||||
|
Thanks for coming! Contributions of any kind are welcome.
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
|
||||||
|
* Fork [React-Templates](https://github.com/wix/react-templates)
|
||||||
|
* Clone your fork
|
||||||
|
* In your `react-templates` directory, run `npm i && grunt all`
|
||||||
|
|
||||||
|
## Submitting an issue
|
||||||
|
|
||||||
|
You can submit an issue [here](https://github.com/wix/react-templates/issues).
|
||||||
|
Please make sure that there isn't already an issue regarding the same matter,
|
||||||
|
and include as many details as possible about the issue and on how to reproduce it,
|
||||||
|
if relevant.
|
||||||
|
|
||||||
|
## Creating a pull request
|
||||||
|
|
||||||
|
* Please adhere to the style and formatting of the code
|
||||||
|
* Write tests for new functionality
|
||||||
|
* Create purposeful and complete commits
|
||||||
|
|
||||||
|
### Before committing
|
||||||
|
|
||||||
|
* Make sure that `grunt all` passes.
|
||||||
|
* Pick a concise commit message
|
||||||
|
|
||||||
|
When working on [wix.github.io/react-templates](http://wix.github.io/react-templates),
|
||||||
|
run `grunt pgall` to create the minified files,
|
||||||
|
but do not include their updated version in your commit.
|
||||||
|
Describe in your PR what you did to the site and we'll update them after the merge.
|
||||||
|
(This is important for preventing merge conflicts in the minified files).
|
@ -361,8 +361,12 @@ export default function () {
|
|||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
See the [Contributing page](CONTRIBUTING.md).
|
||||||
|
|
||||||
## License
|
## License
|
||||||
Copyright (c) 2014 Wix. Licensed under the MIT license.
|
Copyright (c) 2015 Wix. Licensed under the MIT license.
|
||||||
|
|
||||||
[npm-image]: https://img.shields.io/npm/v/react-templates.svg?style=flat-square
|
[npm-image]: https://img.shields.io/npm/v/react-templates.svg?style=flat-square
|
||||||
[npm-url]: https://npmjs.org/package/react-templates
|
[npm-url]: https://npmjs.org/package/react-templates
|
||||||
|
@ -25,7 +25,7 @@ $ rt <filename>[,<filename>] [<args>]
|
|||||||
Options:
|
Options:
|
||||||
-h, --help Show help.
|
-h, --help Show help.
|
||||||
-c, --color Use colors in output. - default: true
|
-c, --color Use colors in output. - default: true
|
||||||
-m, --modules String Use output modules. (amd|commonjs|es6|none) - default: none
|
-m, --modules String Use output modules. (amd|commonjs|es6|typescript|none) - default: none
|
||||||
-r, --force Force creation of output. skip file check. - default: false
|
-r, --force Force creation of output. skip file check. - default: false
|
||||||
-f, --format String Use a specific output format. (stylish|json) - default: stylish
|
-f, --format String Use a specific output format. (stylish|json) - default: stylish
|
||||||
-t, --target-version String React version to generate code for (0.12.1, 0.12.0, 0.11.2, 0.11.1, 0.11.0, 0.10.0) - default: 0.12.1
|
-t, --target-version String React version to generate code for (0.12.1, 0.12.0, 0.11.2, 0.11.1, 0.11.0, 0.10.0) - default: 0.12.1
|
||||||
@ -47,7 +47,7 @@ This option allows to override the output file even if there are no changes.
|
|||||||
|
|
||||||
### `-m`, `--modules`
|
### `-m`, `--modules`
|
||||||
|
|
||||||
Use output modules. (amd|commonjs|none|typescript) - default: none
|
Use output modules. (amd|commonjs|es6|typescript|none) - default: none
|
||||||
|
|
||||||
### `-f`, `--format`
|
### `-f`, `--format`
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user