Skip to content

Commit b28109f

Browse files
authored
Merge pull request #399 from CrisKrus/398-add-info-about-branch-names-and-commits
docs: add branch names and semantic commit messages
2 parents 691eac3 + 3d1c4e2 commit b28109f

1 file changed

Lines changed: 33 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,3 +138,36 @@ Para las vistas, preferimos, en general, usar funciones en vez de vistas
138138
basadas en clases. En ningún caso debe entenderse esta recomendación como una
139139
prohibición de usar _CBV_, es solo que preferimos usarlas para casos sencillos
140140
y/o triviales, y usar funciones para todo lo demás.
141+
142+
### Nombres de ramas y commits
143+
144+
A la hora de crear una rama para contribuir en este proyecto hemos de seguir
145+
la nomenclatura propuesta. Para una tarea como
146+
["[389]Añadir un blog"][add-blog-issue] tendremos que crear la rama de la
147+
siguiente forma `git checkout -b 389-add-blogs`. Es decir, ponemos como primera
148+
parte el número de la issue, luego el nombre en el idioma que más cómodo nos sea.
149+
150+
[add-blog-issue]:https://github.com/pythoncanarias/pycan-web/issues/389
151+
152+
```bash
153+
git checkout -b <issue number>-<issue-name>
154+
```
155+
156+
En cuanto a los commits, este proyecto sigue la guía definida en
157+
semantic commit messages la cual se basa en una primera parte dónde explicamos
158+
que estámos haciendo, el scope. Este puede ser `feat`, `fix`, `docs` entre
159+
otros. Y, a continuación, el mensaje del commit explicativo.
160+
161+
Scopes aceptados:
162+
163+
- `feat`: nueva funcionalidad para el usuario, no funcionalidades para scripts de compilación.
164+
- `fix`: solución a un fallo para el usuario, no fallos de scripst de compilación.
165+
- `docs`: cambios en la documentación.
166+
- `style`: formateado, faltas de puntos y coma, etc. No cambios en código de producción.
167+
- `refactor`: refactor de código en producción. Por ejemplo, cambio de nombre de variable.
168+
- `test`: añadir test faltantes, refactorizar test. No cambios en código de producción.
169+
- `chore`: actualización de tareas rutinarias, etc. No cambios en código de producción.
170+
171+
```bash
172+
git commit -m 'feat: add blog template'
173+
```

0 commit comments

Comments
 (0)