|
7 | 7 | A collection of vanilla react and tailwind components, fields and
|
8 | 8 | output formats written in typescript.
|
9 | 9 |
|
10 |
| -Checkout the [Examples](https://cblanquera.github.io/frui) |
11 |
| - |
12 |
| -### Why? |
13 |
| - |
14 |
| -Working on a few projects that require the same fields and easy mapping |
15 |
| -to database columns. I looked around for typescript react interfaces |
16 |
| -*(both the free and paid versions)* without luck. |
17 |
| - |
18 |
| -Mostly I created this component repository for selfish reasons and will |
19 |
| -be adding more components as are needed in my projects. |
| 10 | +Checkout the [Examples](https://ossphilippines.github.io/frui) |
20 | 11 |
|
21 | 12 | ## Install
|
22 | 13 |
|
@@ -135,4 +126,36 @@ import FieldSelect from 'frui/tailwind/FieldSelect';
|
135 | 126 | - Separated (Space, Comma, Line)
|
136 | 127 | - Table
|
137 | 128 | - Taglist
|
138 |
| - - Yesno |
| 129 | + - Yesno |
| 130 | + |
| 131 | +## Contributing |
| 132 | + |
| 133 | +Thanks for being an awesome developer! We are always looking for |
| 134 | +contributors and sponsors. If your interested, |
| 135 | +[contact us](https://github.com/OSSPhilippines) so we can discuss. |
| 136 | +Clone this repo and run the following commands in the project folder. |
| 137 | + |
| 138 | +```js |
| 139 | +$ yarn |
| 140 | +$ yarn build |
| 141 | +$ yarn start |
| 142 | +``` |
| 143 | + |
| 144 | +Please follow the steps below to properly contribute to this repository. |
| 145 | + |
| 146 | +> Do not commit code that is not related to a GitHub issue! |
| 147 | +
|
| 148 | +> Please tag all your commits with `[type]/[issue#]`. |
| 149 | +
|
| 150 | +> Please include the time it took per commit. ie. `1s` or `1h`. |
| 151 | +
|
| 152 | + 1. Per issue on Github, you should create a branch. example: `[type]/[issue#]` |
| 153 | + - Per feature you should create a feature branch. ie. `feature/1001`. |
| 154 | + - Per bug you should create a fix branch. ie. `fix/1002`. |
| 155 | + - Per task you should create a task branch. ie. `task/1003` |
| 156 | + 2. Commits need to reference the issue that is being worked on. example: `updated copy #1004` or `fixes #1005` |
| 157 | + - It's also good to to add the amount of time to your commit message. example: `fixed button #1006 30m` or `built awsome feature #1007 16h` |
| 158 | + 3. When you are finished with your branch, you should create a pull request back to the `main` branch. |
| 159 | + - Assign another developer to review your code. |
| 160 | + - All contributors are expected to both write and review code. |
| 161 | + - Ask [Dev lead](https://github.com/cblanquera) for assignments. |
0 commit comments