Skip to content

Commit 6ef9ffb

Browse files
author
Markus Günther
committed
Docs: Adds contribution section
Discribes you to contribute and how to follow the commit message guidelines.
1 parent d7dcbfa commit 6ef9ffb

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@
1414
<a href="https://github.com/prettier/prettier">
1515
<img alt="code style: prettier" src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square">
1616
</a>
17+
<a href="https://github.com/semantic-release/semantic-release">
18+
<img alt="We are using semantic-release" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square">
19+
</a>
1720
<a href="https://twitter.com/friendsofreact">
1821
<img alt="Follow friends of react on Twitter" src="https://img.shields.io/twitter/follow/friendsofreact.svg?label=follow+friendsofreact&style=flat-square">
1922
</a>
@@ -192,6 +195,28 @@ The returned component accepts a `theme`, `composeTheme`, `innerRef` and `mapThe
192195
- [`composeTheme = 'deeply'`] *(String)* allows to customize the way themes are merged or to disable merging completely. The accepted values are `deeply` to deeply merge themes, `softly` to softly merge themes and `false` to disable theme merging.
193196
- [`mapThemrProps = (props, theme) => ({ ref, theme })`] *(Function)* allows to customize how properties are passed down to the decorated component. By default, themr extracts all own properties passing down just `innerRef` as `ref` and the generated theme as `theme`. If you are decorating a component that needs to map the reference or any other custom property, this function is called with *all* properties given to the component plus the generated `theme` in the second parameter. It should return the properties you want to pass.
194197
198+
## Contribution
199+
200+
Contributions are always welcome. We try to make it as easy as possible.
201+
We are using semantic-release to have more time to concentrate on important stuff
202+
instead of struggling in the dependency or release hell.
203+
204+
Therefore the first rule is to follow the [eslint commit message guideline](https://github.com/conventional-changelog-archived-repos/conventional-changelog-eslint/blob/master/convention.md).
205+
When you always commit via `yarn commit` this is really easy. Commitizen will guide you.
206+
207+
### Development commands
208+
209+
We have some yarn scripts that should make live easier. The deployment scripts are just for
210+
semantic-release and travis, but the following will help you.
211+
212+
| Command | Description |
213+
| --------------- | ------------------------------ |
214+
| `yarn build` | Runs the development build. |
215+
| `yarn lint` | Executes linter, we use prettier with eslint. |
216+
| `yarn test` | Executes the jest test on all source files. |
217+
| `yarn test:watch` | Perfect while writing tests is the watcher for test. |
218+
| `yarn commit` | Executes commitizen to guide you for the correct commit message. |
219+
195220
## About
196221
197222
The project is originally authored by [Javi Velasco](https://twitter.com/javivelasco) as an effort of providing a better customization experience for [React Toolbox](http://react-toolbox.io). Any comments, improvements or feedback is highly appreciated.

0 commit comments

Comments
 (0)