2.1 KiB
CONTRIBUTING
Requerimientos:
- Node v16 o superior descargar node
- Yarn como gestor de paquetes. En el link conseguiras las intrucciones para instalar yarn.
- Se usara la rama dev (https://github.com/leifermendez/bot-whatsapp/tree/dev) como rama principal hasta que se haga oficialmente el lanzamiento de la V2
💡 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
git clone --branch dev https://github.com/leifermendez/bot-whatsapp
Instalar dependencias
cd bot-whatsapp
yarn install
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
Linking
yarn link.dist
Example-app
yarn run cli
Abrir carpeta example-app-base
npm link @bot-whatsapp/bot -S
npm link @bot-whatsapp/provider -S
npm link @bot-whatsapp/database -S
npm i
npm start
Commit y Push El proyecto tiene implementado husky es una herramienta que dispara unas acciones al momento de hacer commit y hacer push
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í
push: Cada push ejecutar yarn run test el cual ejecuta los test internos que tienen que cumplir con 95% de cobertura.