docs(contributin): added more info

This commit is contained in:
Leifer
2022-11-29 22:13:58 +01:00
parent 9351af16b7
commit e5cecdee03
2 changed files with 23 additions and 3 deletions

View File

@@ -7,14 +7,14 @@
>💡 Se usa la version 3.3.0 o superior de Yarn para establecer esta version simplemente ejecuta el siguiente comando: `yarn set version 3.3.0`
__Clonar repo rama dev__
```shell
```
git clone --branch dev https://github.com/leifermendez/bot-whatsapp
```
__Instalar dependencias__
```shell
```
cd bot-whatsapp
yarn set version 3.3.0
yarn
yarn install
```
> __ATENCIÓN__ Si esta estas en ubuntu/linux ejecutar lo siguiente comandos adicionales.
@@ -29,6 +29,25 @@ El proyecto tiene implementado __[husky](https://typicode.github.io/husky/#/)__
__commit:__ Los commit son semanticos esto quiere decir que deben cumplir un standar al momento de escribirlos ejemplo ` feat(adapter): new adapter myqsl ` puede ver más info sobre esto __[aquí](https://github.com/conventional-changelog/commitlint/#what-is-commitlint)__
__Compilar (build)__
Para compilar la aplicación es necesario ejecutar, eso te genera dentro de packages del monorepo un directorio `lib`
```
yarn build
```
Luego de ejecutar el comando conseguiras algo como lo siguiente. Esas carpetas lib NO se suben al repo estan ignoradas.
```
packages/bot/lib
packages/cli/lib
packages/database/lib
packages/provider/lib
```
__Example-app__
------
- [Discord](https://link.codigoencasa.com/DISCORD)
- [Twitter](https://twitter.com/leifermendez)

View File

@@ -29,3 +29,4 @@
- [ ] Meta adapter
### @bot-whatsapp/cli
- [ ] Hacer comando para crear `example-app`