Contribuindo

Modelo de branchs do Git

O modelo de branchs desse repositório é inspirado pelo Git Flow. Atualmente nós temos esses tipos de branches:

• master - Último release, estável (stable)
• develop - Principal de desenvolvimento, Instável (unstable)
• release/ - Arquivo de release
• feature/ - Desenvolvimento específico de uma funcionalidade
• example/ - Exemplos para ajudar
• hotfix/ - Ajustes emergenciais para o último release

Leia a referência do Git Flow. Este repositório usa Versionamento semântico.

Criando módulos

Uma ótima notícia é que a cada vez que você criar qualquer coisa no Styleguide, já será um módulo. Dessa forma vamos conseguir criar um bom recurso para toda a comunidade.

Não esqueça de ler sobre a Estrutura de Módulos e Como os módulos funcionam antes de seguir adiante.

_data.json

Você pode criar qualquer par de chave-valor neste arquivo para utilizar no seu módulo.

Exemplos:

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

Jade

No arquivo .jade, você pode usar todas as informações do _data.json:

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

Javascript

Caso o seu módulo tenha Javascript, use a chave scripts e coloque o caminho dos arquivos:

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

Alterandoa estrutura

Dependências

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

Harp

Harp é usado por ambos, servir e compilar aquivos, tais ações são feitas através do Start.app e Compile.app. O Start.app usa o arquivo de Node.js para configurar o Livereload e o Harp juntos.

Scripts

O código fonte do Start.app e Compile.app estão dentro de cada conteúdo interno do app: Contents/Resources/script

Arquivos Node

Na pasta styleguide/structure/_node-files você achará o código para:

• Iniciar o Harp
• Iniciar Livereload
• Escrever a data atual para o arquivo styleguide/_data.json (no start and compile)
• Concatenar todos os códigos dos módulos javascript em um arquivo em styleguide/assets/scripts/styleguide.js
• Concatenar todos os códigos de estilo em um arquivo em styleguide/assets/styles/styleguide.js

Estrutura CSS

No diretório styleguide/structure/styles está presente a o estilo da estrutura (header, sidebar e componentes básicos), sem qualquer código de módulo específico.

Estrutura Javascript

No diretório styleguide/structure/scripts está presente o javascript da estrutura (header, sidebar e componentes básicos), sem qualquer código de módulo específico.

Dados de módulos

A styleguide/structure/_includes/modulesData.jade é responsável por coletar todos os dados necessários para todos os módulos em um único objeto que será usado por toda a estrutura de arquivos.

Pull Request

A fim de realizar o Pull Request, você deverá primeiramente realizar a validação do seu código utilizando styleguide/structure/_tests/_lint.sh (executar como linha de comando). Códigos com erros de validação não serão aceitos.