Contribution

Modèle de branches sous Git

Le modèle de branches de ce dépôt est inspiré de Git Flow. Actuellement voici les branches disponibles:

• master - Dernière version, stable
• develop - Dévelopement principal, instable
• release/ - Archives de versions
• feature/ - Développement de caractéristiques spécifiques
• example/ - Exemples utiles
• hotfix/ - Correctifs d'urgence pour la dernière version

Lire la documentation de Git Flow (anglais). Ce dépôt utilises la gestion sémantique de version.

Création de modules

La bonne nouvelle est que tout ce que vous créée dans Styleguide sera traité en tant que module. Ainsi nous pouvons integrer une super ressource pour la communauté.

N'oubliez pas de lire "How modules work (anglais)" et "Module Structure (anglais" avant d'aller plus loin.

###_data.json Vous pouvez définir une valeur-clé dans ce fichier pour être utilisée dans votre module.

Exemples:

"elements": {
    "personnes": [
        {
            "nom": "John",
            "age": "32"
        },
        {
            "nom": "Kirsten",
            "age": "28"
        }
    ]
}

Jade

Vous pouvez utiliser toutes les données de _data.json dans le fichier .jade.

table
    each personne in personnes
        tr
            td=personne.nom
            td=personne.age

Javascript

Au cas ou vous auriez besoin de javascript pour votre module, utilisez les clés de script et les chemins d'accès.

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

Changer la structure

Dépendances

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

Harp

Harp est utilisé en tant que serveur local et pour la compilation. Ces actions s'effectuent avec Start.app et Compile.app. Start.app utilise un fichier Node.js pour configurer Livereload et Harp conjointement.

Scripts

Les sources de Start.app et Compile.app se trouvent dans chaque contenu d'application respectif: Contents/Resources/script

Fichiers Node

Dans dossier styleguide/structure/_node-files vous trouverez le code qui:

• Lance Harp
• Lance Livereload
• Inscrit la date du jour dans le fichier styleguide/_data.json (avec start et compile)
• Concatène tous les modules javascript en un fichier dans styleguide/assets/scripts/styleguide.js
• Concatène tous les fichiers css en un fichier dans styleguide/assets/styles/styleguide.js

Structure CSS

Dans le dossier styleguide/structure/styles se trouve la feuille de style de la structure (header, sidebar et composants basiques), sans code de module spécifique.

Structure Javascript

Dans le dossier styleguide/structure/scripts se trouve le javascript de la structure (header, sidebar et composants basiques), sans code de module spécifique.

Modules Data

Le ficher styleguide/structure/_includes/modulesData.jade est responsable de la collecte de toutes les informations et modules en un seul objet qui sera utilisé par tous les fichiers de structure.

Pull Request

Pour effectuer une Pull Request, il vous faut d'abord nettoyer votre code avec styleguide/structure/_tests/_lint.sh (à executer en ligne de commande). Un code avec erreurs ne sera pas accepté.