Adds CONTRIBUTING.md

This commit is contained in:
kikito
2015-07-30 17:41:25 +02:00
parent 3cd3adcb19
commit 250358bcaf

38
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,38 @@
## Miembros del equipo
* Raimond Garcia [github](https://github.com/voodoorai2000) | [twitter](https://twitter.com/voodoorai2000)
* Juanjo Bazán [github](https://github.com/xuanxu) | [twitter](https://twitter.com/xuanxu)
* Enrique García Cota [github](https://github.com/kikito) | [twitter](https://twitter.com/otikik)
* Alberto Garcia Cabeza [github](https://github.com/decabeza) | [twitter](https://twitter.com/decabeza)
## Comunicación general y de incidencias
El método preferido para informar sobre una incidencia en el proyecto es [creando una incidencia en la cuenta de Github del proyecto](https://github.com/AyuntamientoMadrid/participacion/issues/new).
Para comunicación más puntual e informal, contacta con los miembros del equipo por twitter.
## Resolver una incidencia
Cuando quieras resolver una incidencia mediante código:
* Avisa de que vas a trabajar en esta incidencia añadiendo un comentario
* Haz un fork del proyecto
* Crea una rama para resolver la incidencia desde la rama `master`
* Añade el código necesario para resolver la incidencia en tantos commits como sea preciso
* Asegúrate de que los tests pasan (y escribe más tests para probar la nueva funcionalidad si fuera preciso)
* Envía una *pull request* al repositorio principal indicando que la incidencia que se está arreglando
## Otras formas de contribuir sin código
* Si crees que hay una funcionalidad que hace falta, o descubres un problema, abre una incidencia (asegúrate de que
no haya una incidencia para ya abierta antes)
* También puedes ayudar dando este proyecto a conocer
## Cómo escribir una incidencia
* Trata de darle un título descriptivo (algo más que "xxx no funciona").
* Es buena idea incluir las siguientes secciones:
* Pasos que se han realizado para producir la incidencia
* Lo que se esperaba que pasara
* Lo que ha pasado
* También es buena idea que incluyas tu sistema operativo, navegador, versión de navegador y plugins instalados.