CONTRIBUTING
Welcome
¡Nos alegra que estés interesado en contribuir a nuestro proyecto! Aquí encontrarás toda la información necesaria para empezar a colaborar. Puede contribuir de varias maneras, ya sea actualizando la documentación, mejorando el código, revisando los problemas pendientes en elissues, o incluso realizando aportaciones económicas, que se destinarán a diversos fines relacionados con el desarrollo y mantenimiento del proyecto. Puedes ver más detalles sobre cómo hacer aportaciones económicas here.
El lenguaje principal que utilizamos en este proyecto es TypeScript, que nos permite mantener un código legible y escalable.
Frequent Questions
Aquí hay algunas respuestas a las preguntas frecuentes que pueden surgir al contribuir al proyecto:
- What is Lerna? Puedes encontrar una definición de esto video.
- How do I make commits effectively? Aqui te muestro como hacerlo video
- What are our communication channels? Puedes unirte a la comunidad Discord.
Requirements:
Antes de comenzar a contribuir al proyecto, asegúrese de tener instaladas las siguientes herramientas:
- Node.js: Versión 18 o superior. Puede descargar Node desde here.
- pnpm: Gestor de paquetes. Puede instalarlo siguiendo las instrucciones here.
- VSCode: Editor de código que recomendamos, ya que tiene complementos útiles.
- Conventional Commits: Complemento de VSCode que te ayuda a crear confirmaciones semánticas, siguiendo las mejores prácticas. Puedes instalarlo desde here.
Get Starter
Make a fork
Antes de comenzar a trabajar en el proyecto, transfiéralo a su propia cuenta de GitHub. Esto le permitirá trabajar en su propia copia del repositorio. Haga clic en el siguiente enlace para bifurcar: here.
Clone the Repository (from your fork)
Una vez que hayas bifurcado el proyecto, clona tu propia copia del repositorio usando el siguiente comando en tu terminal:
git clone https://github.com/TU_USERNAME/bot-pluginsDependencies install
Vaya a la carpeta del proyecto y ejecute los siguientes comandos para instalar las dependencias necesarias:
cd bot-plugins
pnpm install
pnpm run buildCreate a new integration
Para crear una nueva integración, ejecute el siguiente comando en su terminal:
pnpm run create.package <package_name>compile (build)
Para compilar la aplicación, ejecute el siguiente comando en su terminal. Esto generará un directorio dist dentro de los paquetes de repositorio mono.
npx lerna run build --scope=<package_name>tests environments
Una vez hayas ejecutado la compilación y todo esté correcto, ejecuta el siguiente comando en tu terminal:
pnpm run copy.libEste comando copiará los archivos necesarios en la carpeta base_app. Asegúrese de haber ejecutado previamente npm install dentro de la carpeta base_app Luego, desde la raíz de su directorio, ejecute:
pnpm run copy.libPara iniciar el asistente, ejecute:
npm run devDebería funcionar sin problemas.
Test End-to-End (E2E)
Todos los cambios realizados deben pasar las pruebas end-to-end. Estas pruebas se ejecutan con el siguiente comando:
pnpm run testAsegúrese de tener una carpeta de prueba y archivos con el .test.ts para sus tests.