Skip to content

Commit 8b1c09c

Browse files
Merge pull request #91 from TransbankDevelopers/chore/remove-docker
chore: remove docker
2 parents a30695e + 3aa1e61 commit 8b1c09c

File tree

5 files changed

+46
-77
lines changed

5 files changed

+46
-77
lines changed

Dockerfile

-5
This file was deleted.

Makefile

-24
This file was deleted.

README.md

+46-26
Original file line numberDiff line numberDiff line change
@@ -9,23 +9,26 @@ SDK Oficial de Transbank
99
# Instalación
1010

1111
Puedes instalar el SDK directamente
12+
1213
```bash
1314
gem install transbank-sdk
1415
```
1516

1617
o añadirlo a tu `Gemfile`
18+
1719
```ruby
1820
gem 'transbank-sdk'
1921
```
22+
2023
y luego ejecutar
24+
2125
```bash
2226
bundle install
2327
```
24-
## Documentación
2528

26-
Puedes encontrar toda la documentación de cómo usar este SDK en el sitio https://www.transbankdevelopers.cl.
29+
## Documentación
2730

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.
2932

3033
La documentación relevante para usar este SDK es:
3134

@@ -34,45 +37,62 @@ La documentación relevante para usar este SDK es:
3437

3538
## Información para contribuir y desarrollar este SDK
3639

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.
4163

4264
### Standares
4365

4466
- Para los commits respetamos las siguientes normas: https://chris.beams.io/posts/git-commit/
4567
- Usamos ingles, para los mensajes de commit.
4668
- 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`
4870
- Para los nombres de ramas también usamos ingles.
4971
- Se asume, que una rama de feature no mezclada, es un feature no terminado.
5072
- El nombre de las ramas va en minúsculas.
5173
- Las palabras se separan con `-`.
5274
- Las ramas comienzan con alguno de los short lead tokens definidos, por ejemplo: `feat/tokens-configuration`
5375

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** 📖
6177

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.
6381

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**
6983

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.
7493

7594
### Deploy de una nueva versión.
95+
7696
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).
7797

7898
En ese PR deben incluirse los siguientes cambios:
@@ -82,4 +102,4 @@ En ese PR deben incluirse los siguientes cambios:
82102

83103
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.
84104

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.

docker-compose.yml

-20
This file was deleted.

sdk_test.sh

-2
This file was deleted.

0 commit comments

Comments
 (0)