Ver este documento en otro idioma: English / 日本語 / 简体中文 / Português / 한국어
¿Quieres contribuir al proyecto? ¡Genial!
Este proyecto se apega al Código de Conducta convenido para Contribuyentes. Al participar, se espera que te apegues a este código. Por favor, revisa nuestro Código de Conducta para más información acerca de reportar comportamiento no apropiado.
¿Trabajando en tu primer Pull Request? Cómo contribuir a un proyecto de código abierto en GitHub
-
¿Configuración del proyecto? ¡Te tenemos cubierto!
-
¿Encontraste un bug? ¡Házlono saber!
-
¿Arreglaste un bug? ¡Haz un PR!
-
¿Agregando una nueva característica? Asegúrate de abrir un issue describiendo tu característica o mejora, ¡Después abre un nuevo PR cuando estés listo para recibir retroalimentación!
¡Estamos muy felices porque quieras contribuir al proyecto! ❤️ Los siguientes pasos te ayudarán a poner el proyecto en marcha:
- Haz un Fork y Clon del repositorio.
- Instala las dependencias necesarias:
$ npm install
- Ejecuta el servidor de desarrollo:
To view all available components in an interactive interface, use storybook.$ npm run storybook
.
├── index.html: Página demo
├── style.css: Estilo de la página demo
├── css: Archivos de distribución
├── docs: Storybook stories
└── scss: Código fuente
├── base
│ ├── reboot.scss: ¡No cambiar! (Bootstrap Reboot)
│ ├── generic.scss: Estilo general y reboot.css
│ └── variables.scss: Variables comunes
├── elements
├── components
├── form
├── icons: Iconos 16x16
├── pixel-arts: Para iconos que no son 16x16.
└── utilities
Tip: Manten tu rama
master
apuntando al repositorio original y haz pull request de las ramas en tu fork. Para hacer esto, ejecuta:git remote add upstream https://github.com/nostalgic-css/NES.css.git git fetch upstream git branch --set-upstream-to=upstream/master master
Esto añadirá el repositorio original como un "remoto" llamado "upstream", fetch la información de git desde el remoto, y configura tu rama local
master
para utilizar la ramaupstream/master
cuando ejecutesgit pull
. En este punto, tú puedes crear todas tus ramas desde esta ramamaster
. Cuando quieras actualizar tu versión demaster
, haz ungit pull
.
Debajo hay pasos, los cuales deben ser seguidos por los miembros de nostalgic-css
. Colaboradores externos sólo tienen que seguir los pasos anteriores.
- Haz una rama desde
develop
utilizando las siguientes reglas de tomato. - Haz el trabajo para resolver el issue. Si identificas trabajo que no está relacionado con el issue, por favor crea un nuevo issue y haz el trabajo en una rama independiente.
- Envía tus PRs a hacer merge en
develop
.- Todo cambio que pueda afectar el desarrollo actual deberá ser documentado en la descripción.
- PRs con un issue deberán incluir en el título el número del issue. E.g.
[#33] Arregla bug
- Asígnate el PR.
- Cuando el PR esté listo mara ser unido, se deberá solicitar una revisión por parte el equipo de `nostalgic-css/NES.css´.
- Una vez que el PR sea aprobado, será responsabilidad de la persona encargada de unir los cambios a la rama.
Utilizamos Commitizen and commitlint
para asegurarnos que nuestros lanzamientos sean automáticos, unromantic, and unsentimental.