updating CONTRIBUTING

parent e93faad5
Showing with 66 additions and 0 deletions
# Estructura del repositorio
- `master`: versión estable, servida en [pre.yottacode.com][1]
- `develop`: versión con los últimos issues completados, servida
en [dev.yottacode.com][2], se irá añadiendo periódicamente a `master`
- `issue/xxx`: versión con los cambios que resuelven el issue xxx, se unirá
a `develop` cuando se complete
## Antes de unir un issue
Se deben unir todos sus commmits con el comando `git squash` dejando una
descripción del tipo:
```
Fixed/solved #xxx, breve descripción opcional.
- Cambio A
- Cambio B
- ...
```
## Contribuciones menores
Si se quiere añadir un pequeño cambio al repositorio, puede enviarse
directamente a la rama `develop` siempre que pueda describirse brevemente
los cambios que se han realizado.
## Etiquetas
Para organizar los issues estas son las etiquetas que se van a utilizar en
todo el repositorio, organizadas en 3 categorías:
- Tipo:
- `bug`: fallos que deben resolverse
- `improvement`: mejoras y/o sugerencias a implementar
- `refactor`: cambios en la nomenglatura y la documentación
- Campo:
- `android`: cliente android
- `webapp`: aplicación web (sólo el cliente)
- `server`: servidor y base de datos
- `company`: issues relacionados con la empresa (por ejemplo congresos)
- Estado:
- `in-progress`: incidencias en proceso de desarrollo
- `critical`: elementos importantes que deben tener prioridad
# Aspecto del código
- En el fichero [.editorconfig][3] se encuentra el estilo utilizado en el código (en cuento a
espacios, codificación y demás). Existen numerosos plugins que pueden encontrarse en
[editorconfig.org][4].
- En el fichero [/sails/src/.eslintrc][5] se encuentran los estilos referentes a los ficheros de
javascript. Tanto `eslint` como las configuraciones necesarias se encuentran en el fichero
[/sails/src/package.json][6], y se instalarán como dependencias de desarrollo.
> Puede configurarse eslint en el editor usado o ejecutando `eslint [ficheros]` desde
> el directorio [/sails/src][7].
[1]: https://pre.yottacode.com/
[2]: https://dev.yottacode.com/
[3]: /softuno/pictogram/blob/develop/.editorconfig
[4]: http://editorconfig.org
[5]: /softuno/pictogram/blob/develop/sails/src/.eslintrc
[6]: /softuno/pictogram/blob/develop/sails/src/package.json
[7]: /softuno/pictogram/tree/develop/sails/src
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or sign in to comment