Contribuciones
Gracias por mostrar tu interés en contribuir con PancakeSwap !
Pancake es un proyecto open-source. Si quieres contribuir con el proyecto, esta sección está aquí para guiarte a través de tus primeros pasos con el equipo de Pancake 🥞
Configurar tu entorno de desarrollo
Haz un Fork del repositorio y agrega un control remoto ascendente. Por ejemplo:
Asegúrese de que tiene la versión más reciente del Branch predeterminado (
develop
ormaster
)Crea tu propio branch e instala las dependencias.
Codea Feliz! 🎉
Reglas de Código
Tratamos de mantener la mayor coherencia posible entre cada uno de nuestros repositorios. Tu pull request tiene más posibilidades de ser aceptada si sigue algunas de las siguientes reglas y escribe código de alta calidad Empecemos! 💪
Usa el UIKit
Mira el UI Kit antes de empezar a hacer nada. Muchos componentes ya están creados, y no queremos que pierdas el tiempo reinventando la rueda 😉
Si es necesario crear una variante de un componente, utilice el componente correspondiente en el UI Kit como base. Por ejemplo:
Usa las Herramientas!
La mayorías de nuestras repos usan Typescript, ESLint, y Prettier. Asegúrese de que está familiarizado con las mejores prácticas de Typescript y habilite un complemento ESLint y Prettier para su IDE.
Asegúrese de que el código tiene el formato de Prettier y está libre de cualquier error de ESLint antes de enviar una pull request
Algunas Buenas Prácticas
Mantenga los componentes lo más pequeños e "idiotas" como sea posible.
Tenga en cuenta que el código será leído y revisado por varios otros desarrolladores. Haz que sea lo más claro y fácil de actualizar posible.
Confirmación
Nuestros mensajes de confirmación siguen Confirmaciones Convencionales usando commitlint.
Tipo | Descripción |
build | Cambios que afectan al sistema de compilación o a las dependencias externas (ámbitos de ejemplo: gulp, broccoli, npm) |
ci | Cambios en nuestros archivos de configuración y scripts de CI (ámbitos de ejemplo: Travis, Circle, BrowserStack, SauceLabs) |
docs | Cambios sólo en la documentación |
feat | Una nueva característica/Función |
fix | Arreglo de un Bug |
perf | Un cambio de código que mejora performance |
refactor | Un cambio de código que no corrige un error ni agrega una característica |
style | Cambios que no afectan al significado del código (espacios en blanco, formato, falta de punto y coma, etc.) |
test | Agregar pruebas que faltan o corregir pruebas existentes |
Más en Angular's guidelines
Creando tu pull request
Su código está listo para ser enviado para su revisión, felicitaciones🥳
Una pull request debe tener una descripción dé qué es lo que la PR está tratando de lograr.
Mantenga las pull request lo más pequeñas posible. Las pull request más grandes deben dividirse en fragmentos más pequeños con un branch base dedicado. Por favor, marque los PR que se están fusionando en su branch base con la etiqueta
epic
Si es posible, autor revea su PR y agregue comentarios donde sea necesaria una aclaración adicional.
Crea un draft PR lo antes posible así nosotros podemos ver tu proceso en curso.
Gracias por ayudarnos a hacer Pancake aún más impresionante ❤️
Last updated