You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+46-26
Original file line number
Diff line number
Diff line change
@@ -9,23 +9,26 @@ SDK Oficial de Transbank
9
9
# Instalación
10
10
11
11
Puedes instalar el SDK directamente
12
+
12
13
```bash
13
14
gem install transbank-sdk
14
15
```
15
16
16
17
o añadirlo a tu `Gemfile`
18
+
17
19
```ruby
18
20
gem 'transbank-sdk'
19
21
```
22
+
20
23
y luego ejecutar
24
+
21
25
```bash
22
26
bundle install
23
27
```
24
-
## Documentación
25
28
26
-
Puedes encontrar toda la documentación de cómo usar este SDK en el sitio https://www.transbankdevelopers.cl.
29
+
## Documentación
27
30
28
-
Actualmente este SDK contiene sólo Onepay.
31
+
Puedes encontrar toda la documentación de cómo usar este SDK en el sitio https://www.transbankdevelopers.cl.
29
32
30
33
La documentación relevante para usar este SDK es:
31
34
@@ -34,45 +37,62 @@ La documentación relevante para usar este SDK es:
34
37
35
38
## Información para contribuir y desarrollar este SDK
36
39
37
-
### Requerimientos
38
-
- Docker
39
-
- Make
40
-
- Plugin de editorconfig para tu editor favorito.
40
+
#### Short lead tokens
41
+
42
+
`WIP` = En progreso.
43
+
44
+
`feat` = Nuevos features.
45
+
46
+
`fix` = Corrección de un bug.
47
+
48
+
`docs` = Cambios solo de documentación.
49
+
50
+
`style` = Cambios que no afectan el significado del código. (espaciado, formateo de código, comillas faltantes, etc)
51
+
52
+
`refactor` = Un cambio en el código que no arregla un bug ni agrega una funcionalidad.
53
+
54
+
`perf` = Cambio que mejora el rendimiento.
55
+
56
+
`test` = Agregar test faltantes o los corrige.
57
+
58
+
`chore` = Cambios en el build o herramientas auxiliares y librerías.
59
+
60
+
`revert` = Revierte un commit.
61
+
62
+
`release` = Para liberar una nueva versión.
41
63
42
64
### Standares
43
65
44
66
- Para los commits respetamos las siguientes normas: https://chris.beams.io/posts/git-commit/
45
67
- Usamos ingles, para los mensajes de commit.
46
68
- Se pueden usar tokens como WIP, en el subject de un commit, separando el token con `:`, por ejemplo:
47
-
`WIP: This is a useful commit message`
69
+
`WIP: This is a useful commit message`
48
70
- Para los nombres de ramas también usamos ingles.
49
71
- Se asume, que una rama de feature no mezclada, es un feature no terminado.
50
72
- El nombre de las ramas va en minúsculas.
51
73
- Las palabras se separan con `-`.
52
74
- Las ramas comienzan con alguno de los short lead tokens definidos, por ejemplo: `feat/tokens-configuration`
53
75
54
-
#### Short lead tokens
55
-
##### Commits
56
-
- WIP = Trabajo en progreso.
57
-
##### Ramas
58
-
- feat = Nuevos features
59
-
- chore = Tareas, que no son visibles al usuario.
60
-
- bug = Resolución de bugs.
76
+
### **Reglas** 📖
61
77
62
-
### Todas las mezclas a master se hacen mediante Pull Request.
78
+
1. Todo PR debe incluir test o evidencia de que funcione correctamente(gif, foto).
79
+
2. El PR debe tener 2 o más aprobaciones para poder mezclarse.
80
+
3. Si un commit revierte un commit anterior deberá comenzar con "revert:" seguido del mensaje del commit anterior.
63
81
64
-
### Test
65
-
Primero y solamente una vez para instalar gemas debes usar el siguiente comando en una terminal.
66
-
```bash
67
-
make build
68
-
```
82
+
### **Pull Request**
69
83
70
-
Para ejecutar los test localmente debes usar el siguiente comando en una terminal.
71
-
```bash
72
-
make
73
-
```
84
+
- Usar un lenguaje imperativo y en tiempo presente: "change" no "changed" ni "changes".
85
+
- El título del los PR y mensajes de commit no pueden comenzar con una letra mayúscula.
86
+
- No se debe usar punto final en los títulos o descripción de los commits.
87
+
- El título del PR debe comenzar con el short lead token definido para la rama, seguido de : y una breve descripción del cambio.
88
+
- La descripción del PR debe detallar los cambios.
89
+
- La descripción del PR debe incluir evidencias de que los test se ejecutan de forma correcta.
90
+
- Se pueden usar gif o videos para complementar la descripción o evidenciar el funcionamiento del PR.
91
+
92
+
### Todas las mezclas a master se hacen mediante Pull Request.
74
93
75
94
### Deploy de una nueva versión.
95
+
76
96
Para generar una nueva versión, se debe crear un PR (con un título "Prepare release X.Y.Z" con los valores que correspondan para `X`, `Y` y `Z`). Se debe seguir el estándar semver para determinar si se incrementa el valor de `X` (si hay cambios no retrocompatibles), `Y` (para mejoras retrocompatibles) o `Z` (si sólo hubo correcciones a bugs).
77
97
78
98
En ese PR deben incluirse los siguientes cambios:
@@ -82,4 +102,4 @@ En ese PR deben incluirse los siguientes cambios:
82
102
83
103
Luego de obtener aprobación del pull request, debe mezclarse a master e inmediatamente generar un release en GitHub con el tag `vX.Y.Z`. En la descripción del release debes poner lo mismo que agregaste al changelog.
84
104
85
-
Con eso Github Actions generará automáticamente una nueva versión de la librería y la publicará en RubyGems.
105
+
Con eso Github Actions generará automáticamente una nueva versión de la librería y la publicará en RubyGems.
0 commit comments