Contribuciones

Modelo de ramas de Git

El modelo de ramas de este repositorio esta inspirado en Git Flow. Actualmente contamos con estos tipos de ramas:

• master - Último release, estable
• develop - Desarrollo principal, inestable
• release/ - Archivo de versiones liberadas
• feature/ - Desarrollo de características específicas
• example/ - Ejemplos de ayuda
• hotfix/ - Correcciones de emergencia para la última versión

Lee la referencia de Git Flow. Este repositorio usa Semantic Versioning.

Creando módulos

Las buenas noticias son que cualquier cosa que crees en el Styleguide será tratado como un módulo. De esta forma podremos añadir un increíble recurso a la comunidad.

No olvides leer acerca de "Como funcionan los módulos" y "Estructura de un módulo" antes de continuar.

_data.json

Puedes definir un key-value en este archivo que luego será usado en tu módulo.

Ejemplos:

"items": {
  "people": [
    {
      "name": "John",
      "age": "32"
    },
    {
      "name": "Kirsten",
      "age": "28"
    }
  ]
}

Jade

Puedes usar toda la información contenida en _data.json dentro del archivo .jade:

table
  each folk in people
    tr
      td=folk.name
      td=folk.age

JavaScript

En caso de que necesites JavaScript para un módulo, usa la clave (key) scripts y añade la ruta del archivo:

"scripts": ["vendor/foundation.equalizer.js", "pricing-tables.js"]

Cambiando la estructura

Dependencias

• Node.js
• Harp.js
• Node Livereload
• Node Watch

Harp

Harp es usado para compilar y servir archivos, dichas acciones son realizadas a través de Start.app y Compile.app. Start.app usa un archivo de Nodejs para configurar Livereload y Harp al mismo tiempo.

Scripts

El código fuente de Start.app y Compile.app están dentro de cada uno de los contenidos de la aplicación: Contents/Resources/script

Archivos Node

En el directorio styleguide/structure/_node-files encontrarás el código que:

• Inicia Harp
• Inicia Livereload
• Escribe la fecha actual en el archivo styleguide/_data.json (en start y compile)
• Concatena todos los módulos JavaScript en un solo archivo styleguide/assets/scripts/styleguide.js
• Concatena todos los módulos de estilos en un solo archivo styleguide/assets/styles/styleguide.js

Estructura CSS

En el directorio styleguide/structure/styles está la hoja de estilo de la estructura (header, sidebar y componentes básicos), sin código específico de algún módulo.

Estructura JavaScript

En el directorio styleguide/structure/scripts está el JavaScript de la estructura (header, sidebar y componentes básicos), sin código específico de algún módulo.

Información de módulos

El archivo styleguide/structure/_includes/modulesData.jade es responsable de recolectar toda la información necesaria de todos los módulos en un solo objeto que será usado por todos los archivos de la estructura.

Pull Request

Para realizar un Pull Request, debes primero verificar tu código con styleguide/structure/_tests/_lint.sh (ejecutar en la línea de comandos). Código con errores de estilo no será aceptado.