Skip to content

Commit 1b49d39

Browse files
committed
docs: add branch names and semantic commit messages
1 parent f157153 commit 1b49d39

1 file changed

Lines changed: 27 additions & 3 deletions

File tree

CONTRIBUTING.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,6 @@ consultar o cambiar su estado interno, pero que cualquier interacción con
8181
otras clases o componentes debe realizarse fuera de la clase, preferiblemente
8282
en un módulo aparte.
8383

84-
8584
### Asigna nombres únicos a las clases
8685

8786
Hay muchas razones para esto, pero veamos solo una. Si nos encontramos con una
@@ -105,10 +104,35 @@ sido preferible haber buscado otro nombre que no estuviera en conflicto con uno
105104
ya existente (`@jileon`: Yo lo sé bien ya que fui yo el que creó la clase
106105
duplicada).
107106

108-
109107
### Funciones vs clases para vistas
110108

111109
Para las vistas, preferimos, en general, usar funciones en vez de vistas
112110
basadas en clases. En ningún caso debe entenderse esta recomendación como una
113111
prohibición de usar _CBV_, es solo que preferimos usarlas para casos sencillos
114-
y/o triviales, y usar funciones para todo lo demás.
112+
y/o triviales, y usar funciones para todo lo demás.
113+
114+
### Nombres de ramas y commits
115+
116+
A la hora de crear una rama para contribuir en este proyuecto hemos de seguir
117+
la nomenclatura propuesta. Para una tarea como
118+
["[389]Añadir un blog"][add-blog-issue] tendremos que crear la rama de la
119+
siguiente forma `git branch 389-add-blogs`. Es decir, ponemos como primera
120+
parte el número de la issue, luego el nombre en inglés.
121+
122+
[add-blog-issue]:https://github.com/pythoncanarias/pycan-web/issues/389
123+
124+
```bash
125+
git branch <issue number>-<issue-name>
126+
```
127+
128+
En cuanto a los commits, este proyecto sigue la guía definida en
129+
[semantic commit messages][semantic-commit-messages] la cual se basa en
130+
una primera parte dónde explicamos que estámos haciendo, el scope. Este
131+
puede ser `feat`, `fix`, `docs` entre otros (el resto en el enlace). Y,
132+
a continuación, el mensaje del commit explicativo.
133+
134+
[semantic-commit-messages]:https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716
135+
136+
```bash
137+
git commit -m 'feat: add blog template'
138+
```

0 commit comments

Comments
 (0)