# Contributions

introduction
Commençons
- Exigences
- Exécuter
Faire un PR (Pull Request)
Comment suggérer une fonctionnalité ou une amélioration.
Processus d'examen du code

Veuillez prendre un moment pour examiner ce document et rendre le processus de contribution facile et efficace pour toutes les personnes impliquées.

# introduction

Êtes-vous ici parce que vous souhaitez donner votre PLUS et améliorer notre documentation? Soyez les bienvenus et lisez les sections suivantes pour savoir comment poser des questions et comment travailler sur quelque chose.

Tous les membres de notre équipe doivent suivre notre Code de conduite. Assurez-vous que vous êtes sympathique dans tous nos espaces.

Il existe de nombreuses façons de contribuer, de la rédaction de didacticiels à l'amélioration de la documentation, en envoyant des demandes de fonctionnalités ou en écrivant du code pouvant résoudre un problème courant.

Gardez à l'esprit:

Nous avons un style de programmation
Nous utilisons Message Convention for commits
Les fichiers GIF doivent avoir une taille inférieure à 2 Mo pour que le ** service worker ** puisse le mettre en cache
Vous devez utiliser des balises pour faire référence à des mots clés autres que h1, h2 ou h3, ils peuvent être h4 ou h5, ou des mots clés pour les faire apparaître dans les résultats de recherche.
- dans chaque fichier .md il ressemble à ceci, il suffit d'en ajouter autant que nécessaire
- ```
    ---
    date: 2020-3-10 3:30:18 
    collaborators:
      - Roy Calderon
      - Neiro Méndez
    meta:
      - name: description
        content: Docs PLUSTEAM
      - name: keywords
        content: Tech, PLUS, TEAM
    tags:
      - Tag 1
      - Tag 2
      - Tag N
    ---
```
  1
  2
  3
  4
  5
  6
  7
  8
  9
  10
  11
  12
  13
  14
  15
  - Et quand il y a une correspondance, vous le remarquerez car seul le titre principal de la page correspondante apparaît. Dans cet exemple, la page Contributions apparaît sur la page de résultats car elle contient une balise appeléeTags
  - N'utilisez pas de balises avec le même mot dans le document qui contiennent un h1, h2 ou h3 dans un fichier md car il n'apparaîtra pas dans la recherche

# Commençons

Clonez simplement le projet à partir du référentiel assurez-vous que vous disposez de la configuration requise et exécutez-la.

# Exigences

NodeJS
VuePress

# installer globalement
yarn global y vuepress 
# OR 
npm install -g vuepress

1
2
3
4

# Exécuter

Accédez au dossier du projet et

# exécuter le projet en mode développement
vuepress dev

1
2

À ce stade, vous êtes prêt à apporter des modifications! N'hésitez pas à demander de l'aide; Ils sont tous débutants au début

# Faire un PR (Pull Request)

Tous les changements commencent dans la branche de développement, nous avons un bref guide pour vous aider

# Comment suggérer une fonctionnalité ou une amélioration.

Nous utilisons Asana Vous pouvez demander la permission à nos fondateurs et entrer dans l'espace de travail pour laisser votre suggestion à + Docs - Backlog

# Processus d'examen du code

Nous avons Lignes directrices sur l'AQ où nous mentionnons tout le processus de révision du Code

← Home