Merge pull request #449 from 1024pix/tech-new-contributing-format

[TECH] Redesign du dossier docs et du contributing.md.

Author: sbedeau

docs/API.md

@@ -0,0 +1,90 @@
+# API
+
+## Conventions de nommage
+
+Les classes prennent une majuscule au début.
+Les modules et variables prennent une minuscule au début.
+Sauf exception, privilégier l'ordre alphabétique pour trier une suite de déclarations, require, ...
+
+```javascript
+// BAD
+const sessionRepository = require(...);
+const assessmentRepository = require(...);
+const certificationRepository = require(...);
+
+// GOOD
+const assessmentRepository = require(...);
+const certificationRepository = require(...);
+const sessionRepository = require(...);
+```
+
+Exemples :
+
+```javascript
+const User = require(...);
+const userRepository = ...
+const userName = ...
+```
+
+Une entité du domaine ne contient pas de préfix.
+
+```javascript
+const User = require('../../User');
+
+const myUser = new User({});
+```
+
+## Déclaration de routes 
+
+Ajout de tags et de notes au moment de la déclaration des routes de l'API.
+
+```javascript
+server.route([
+    {
+      method: 'GET',
+      path: '/api/sessions',
+      config: {
+        handler: sessionController.find,
+        tags: ['api', 'sessions'],
+        notes: [
+          '- **Cette route est restreinte aux utilisateurs authentifiés avec le rôle Pix Master**\n' +
+          '- Elle permet de consulter la liste de toutes les sessions (retourne un tableau avec n éléments)',
+        ]
+      }
+    }
+  ]
+);
+```
+
+## Utilisation de transitionTo
+
+Éviter les `transistionTo` dans le hook `model()`. Privilégier leur utilisation dans l’`afterModel()`, une fois que le modèle est chargé.
+
+```javascript
+// BAD
+export default Route.extend({
+  model() {
+    const store = this.get('store');
+    return store.findRecord('user', this.get('session.data.authenticated.userId'))
+      .then((user) => {
+        if (user.get('organizations.length') > 0) {
+          return this.transitionTo('board');
+        }
+        return user;
+      });
+  },
+});
+
+// GOOD
+export default Route.extend({
+  model() {
+    return this.store.findRecord('user', this.get('session.data.authenticated.userId'));
+  },
+  
+  afterModel(model) {
+    if (model.get('organizations.length') > 0) {
+      return this.transitionTo('board');
+    }
+  }
+});
+```

docs/Accessibilite.md

@@ -0,0 +1,19 @@
+# Accessibilité
+
+## Unités CSS
+
+Utilisation des __rem__ pour les fonts: size, lettering, letter-spaces.  
+Utilisation des __px__ pour le positionnement: padding, border, margin.
+
+```scss
+.my-class {
+  size: 1.3rem;
+  padding: 10px 12px;
+}
+```
+
+## Utilisation des balises <h*> </h*>
+
+Peu importe l'apparence des h*, les personnes qui voient les titres comprennent. En revanche les personnes qui naviguent avec le clavier au __voiceOver__ ont besoin que le html soit explicite le plus possible pour que leur outil sache les lire correctement.
+
+Concrètement, ce n'est pas une mauvaise pratique d'avoir un h1 visuellement plus petit/moins contrasté/etc. qu'un h2. L'important est de conserver une __structure html en cascade__ pour le voiceOver (et le référencement web).

docs/Bookshelf.md

@@ -0,0 +1,10 @@
+# Bookshelf
+
+## Conventions de nommage
+
+Une entité bookshelf doit être préfixée par "Bookshelf".
+```javascript
+const BookshelfUser = require('../../User');
+
+const myBookshelfUser = new BookshelfUser({});
+```