2.2 KiB
CONTRIBUTING
Requerimientos:
- Node v16 o superior descargar node
- Yarn como gestor de paquetes. En el link conseguiras las intrucciones para instalar yarn.
- VSCode (recomendado): Editor de codigo con plugins
- Conventional Commits (plugin-vscode) este plugin te ayudara a crear commit semantico.
- 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
🚀 Iniciando
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
Example-app Se ejecuta el CLI (Command Line Interface) para ayudarte a crear un app-bot de ejemplo
yarn run cli
Abrir carpeta example-app-base y ejecutar
cd example-app-base
npm i
npm run pre-copy
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.
Documento en constaten actualización....