# Transbank
[](https://github.com/ElixirCL/transbank-elixir/actions/workflows/ci.yml)
SDK Transbank no oficial basado en versión Ruby:
+ https://github.com/TransbankDevelopers/transbank-sdk-ruby
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `transbank` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:transbank, "~> 0.1.0"}
]
end
```
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at <https://hexdocs.pm/transbank_sdk>.
## Documentación
Puedes encontrar toda la documentación de cómo usar este SDK en el sitio https://www.transbankdevelopers.cl.
Actualmente este SDK contiene sólo Onepay.
La documentación relevante para usar este SDK es:
- Documentación sobre [ambientes, deberes del comercio, puesta en producción,
etc](https://www.transbankdevelopers.cl/documentacion/como_empezar#ambientes).
## Información para contribuir y desarrollar este SDK
### Requerimientos
- Docker
- Make
- Plugin de editorconfig para tu editor favorito.
### Standares
- Para los commits respetamos las siguientes normas: https://chris.beams.io/posts/git-commit/
- Usamos ingles, para los mensajes de commit.
- Se pueden usar tokens como WIP, en el subject de un commit, separando el token con `:`, por ejemplo:
`WIP: This is a useful commit message`
- Para los nombres de ramas también usamos ingles.
- Se asume, que una rama de feature no mezclada, es un feature no terminado.
- El nombre de las ramas va en minúsculas.
- Las palabras se separan con `-`.
- Las ramas comienzan con alguno de los short lead tokens definidos, por ejemplo: `feat/tokens-configuration`
#### Short lead tokens
##### Commits
- WIP = Trabajo en progreso.
##### Ramas
- feat = Nuevos features
- chore = Tareas, que no son visibles al usuario.
- bug = Resolución de bugs.
### Todas las mezclas a master se hacen mediante Pull Request.
### Test
Primero y solamente una vez para instalar gemas debes usar el siguiente comando en una terminal.
```bash
make build
```
Para ejecutar los test localmente debes usar el siguiente comando en una terminal.
```bash
make
```
### Deploy de una nueva versión.
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).
En ese PR deben incluirse los siguientes cambios:
1. Modificar el archivo `CHANGELOG.md` para incluir una nueva entrada (al comienzo) para `X.Y.Z` que explique en español los cambios **de cara al usuario del SDK**.
2. Modificar [version.rb](./lib/transbank/sdk/version.rb) para poner la nueva versión que corresponde.
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.
Con eso Travis CI generará automáticamente una nueva versión de la librería y la publicará en RubyGems.
