README

Transbank SDK Node.js

Este es el SDK oficial de Transbank para Node.js

Requisitos:

Node.js 8+

Instalación

Instalar con `npm`

Puedes instalar SDK en tu proyecto usando NPM

npm install transbank-sdk

Instalar con `yarn`

ó también instalarlo usando Yarn

yarn add transbank-sdk

Detectar vulnerabilidades con `npm`

# Este comando te permite ver las vulnerabilidades
npm audit

# Este comando te permite reparar las vulnerabilidades
npm audit fix

Documentación

Puedes encontrar toda la documentación de cómo usar este SDK en el sitio www.transbankdevelopers.cl.

La documentación relevante para usar este SDK es:

Documentación general sobre los productos y sus diferencias: Webpay.
Documentación sobre ambientes, deberes del comercio, puesta en producción, etc.
Primeros pasos con Webpay.
Referencia detallada sobre Webpay

Información para contribuir y desarrollar este SDK

Requerimientos

Node.js +8
Plugin de editorconfig para tu editor favorito.

Estándares

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 inglés.
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

Para ejecutar los test localmente debes ejecutar los siguientes comandos en una terminal.

npm install # si es que no se han instaldo todavía
npm run test

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:

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.
Modificar el archivo package.json para que la propiedad "version" apunte a la nueva versión X.Y.Z

Luego de obtener aprobación del pull request, debe mezclarse a master e inmediatamente generar un release en GitHub con el tag X.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 npm.

Vulnerabilidades de seguridad

Si descubres una falla de seguridad dentro de este proyecto, por favor, notifícanos por correo electrónico a transbankdevelopers@continuum.cl. Tomaremos el caso con la mayor celeridad.

Usage no npm install needed!