Skip to content

Commit ed6e674

Browse files
author
Arthur Levoyer
committed
📝 (Readme) Add contributing section to readme
1 parent 2508b4a commit ed6e674

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,17 @@ All of the properties of `View` are supported.
9797
| `onDisplay` | `function` | Called when the component finished to be displayed again. |
9898
| `onTouchTop` | `function` | Called when the Top of the component touch the Top of the ScrollView. (`onDisplay` + `onBeginHidden`) |
9999
| `onTouchBottom` | `function` | Called when the Bottom of the component touch the Top of the ScrollView. (`onHide` + `onBeginDisplayed`) |
100+
### Contributing
101+
102+
All contributions are welcomed, that might be either adding new features, doing some refaco of the exisiting code or fixing bugs.
103+
104+
**How to contribute**
105+
106+
1. Fork the project & clone locally. Follow the initial setup here.
107+
2. Create a branch, naming it either a feature or bug: git checkout -b feature/that-new-feature or bug/fixing-that-bug
108+
3. Code and commit your changes. Write a good commit message. Best would be to use git [commitizen](https://github.com/commitizen/cz-cli)
109+
4. Push to the branch: git push origin feature/that-new-feature
110+
5. Create a pull request for your branch 🎉
100111

101112

102113
## Other open-source modules by the folks at [BAM](http://github.com/bamlab)

0 commit comments

Comments
 (0)