2019-04-15 11:16:32 +03:00
# Contribuer à Hasura graphql-engine
2019-11-06 10:39:35 +03:00
*Premièrement*: si vous êtes incertain ou avez des craintes au sujet de quoi que ce soit,
n'hésitez pas à nous poser des questions sur le [Serveur Discord ](https://discordapp.com/invite/hasura ) dans le canal #contrib . Vous pouvez aussi simplement soumettre une issue ou pull request malgré tout.
Pas d'inquiétude : personne ne vous grondera alors que vous faites de votre mieux.
La pire chose qui pourrait vous arriver serait que l'on vous demande poliment de modifier quelque chose.
2019-04-15 11:16:32 +03:00
Nous apprécions toute contribution, et ne voulons pas qu'une muraille de règles entrave cela.
Cependant, pour ceux qui souhaitent un peu plus d'accompagnement sur la meilleure
2019-11-06 10:39:35 +03:00
manière de contribuer au projet, continuez à lire. Ce document va traiter de ce que nous attendons.
En répondant à tous les critères que nous recherchons, les chance que
2019-04-15 11:16:32 +03:00
nous puissions intégrer ou traiter vos contributions augmenteront.
2020-06-25 12:51:21 +03:00
## Sommaire
[1. Code de conduite ](#code-of-conduct )
[2. Vue d'ensemble ](#overview )
[3. Bienvenue aux contributeurs débutants! ](#first-timers )
[4. Domaines de contributions ](#areas )
[5. Manières de contribuer ](#ways )
[6. Messages de commit ](#commit-messages )
[7. Traductions ](#translations )
< a name = "code-of-conduct" > < / a >
## 1. Code de conduite
Veuillez suivre le [Code de conduite ](./code-of-conduct.french.md ) pour toute contribution à Hasura.
< a name = "overview" > < / a >
## 2. Vue d'ensemble
2019-04-15 11:16:32 +03:00
[hasura/graphql-engine ](https://github.com/hasura/graphql-engine ) est un mono-repo
2019-11-06 10:39:35 +03:00
divisé en 3 composants, chacun ayant son propre guide de contribution:
2019-04-15 11:16:32 +03:00
1. [Server (Haskell) ](../server/CONTRIBUTING.md )
2. [CLI (Go) ](../cli/CONTRIBUTING.md )
2023-02-28 15:03:34 +03:00
3. [Console (JavaScript) ](../frontend/docs/generic-info.md#contributing-to-hasura-console )
2019-04-15 11:16:32 +03:00
Chacun de ces trois composants possède une version unique, désignée soit par le tag git, soit par une
combinaison du nom de la branche et du SHA de commit git.
Pour toutes les contributions, un CLC (Contat de Licence de Contributeur) doit être signé [ici ](https://cla-assistant.io/hasura/graphql-engine ) avant (ou après) que la pull request ait été soumise. Un bot demandera si nécessaire aux contributeurs de signer le CLC au moyen d'un commentaire de pull request.
2020-06-25 12:51:21 +03:00
< a name = "first-timers" > < / a >
## 3. Bienvenue aux contributeurs débutants!
2019-11-06 10:39:35 +03:00
Nous accueillons les nouveaux contributeurs avec joie et serions heureux de vous aider dans vos débuts! Si vous avez des questions, n'hésitez pas!
Vous trouverez toutes les issues adaptées aux débutants [ici ](https://github.com/hasura/graphql-engine/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22 ).
2020-06-25 12:51:21 +03:00
< a name = "areas" > < / a >
## 4. Domaines de contribution
2019-11-06 10:39:35 +03:00
Nous apprécions bien sûr toute contribution pour Hasura, peu importe le composant. Cependant, nous avons déterminé trois domaines particulièrement adaptés à des contributions en open source.
2019-04-15 11:16:32 +03:00
### Documentation
2019-11-06 10:39:35 +03:00
Notre objectif est d'avoir une documentation intuitive et à jour. Si vous souhaitez nous y aider, nous acceptons toute contribution avec joie:
- Signaler du contenu manquant
- Régler les erreurs sur les docs existants
- Ajouter du contenu à la documentation
Le guide de contribution pour la documentation peut être trouvé sur [docs/CONTRIBUTING.md ](../docs/CONTRIBUTING.md ).
2019-04-15 11:16:32 +03:00
### Contenu communautaire
Il n'existe aucun guide spécifique pour la contribution au contenu communautaire.
N'importe quoi pouvant aider la communauté ou les utilisateurs du GraphQL Engine
2019-11-06 10:39:35 +03:00
peut faire partie de cette section.
Nous avons identifié :
- [boilerplates ](../community/boilerplates )
- [sample-apps ](../community/sample-apps )
2019-04-15 11:16:32 +03:00
2019-11-06 10:39:35 +03:00
- [outils ](../community/tools )
2019-04-15 11:16:32 +03:00
2019-11-06 10:39:35 +03:00
N'hésitez pas à soumettre une pull request si vous avez quelque chose à ajouter, même ce qui n'est pas en rapport avec les trois sections mentionnées.
2019-04-15 11:16:32 +03:00
2020-06-25 12:51:21 +03:00
< a name = "ways" > < / a >
## 5. Manières de contribuer
2019-11-06 10:39:35 +03:00
### Signaler un Problème
- Soyez certain de tester avec la dernière version disponible. Il est possible que
2019-04-15 11:16:32 +03:00
le bug que vous rencontrez ait déja été corrigé.
- Précisez les étapes à suivre pour reproduire le problème, en incluant la version
de Postgres, la version de graphql-engine et la plateforme sur laquelle vous les
exécutez (Heroku, Docker, etc ...).
- Veuillez inclure les logs du server, si nécessaire.
2020-06-25 12:51:21 +03:00
### Travailer sur une issue
2019-04-15 11:16:32 +03:00
- Soyez certain qu'il y a une issue associée avec le travail que vous êtes en train de réaliser.
- Si vous travaillez sur une issue, veuillez commenter ce que vous faites pour éviter une duplication
du travail par d'autres.
- Veuillez "squasher" vos commits et ajouter une référence à l'issue en ajoutant `fix #<issue-no>`
ou `close #<issue-no>` dans le message de commit, à la fin.
Par exemple `resolve answers to everything (fix #42)` ou `resolve answers to everything, fix #42`
- Rebasez master avec votre branche avant de soumettre une pull request.
2020-06-25 12:51:21 +03:00
< a name = "commit-messages" > < / a >
## 6. Messages de commit
2019-04-15 11:16:32 +03:00
- La première ligne doit être un résumé des changements, ne dépassant pas 50 caractères, suivi
par une section optionnelle contenant plus de détails au sujet des modifications.
Référez vous à [ce lien ](https://github.com/erlang/otp/wiki/writing-good-commit-messages )
pour plus d'informations à propos de l'écriture de bons messages de commit.
- Utilisez l'impératif présent: "add/fix/change", et non "added/fixed/changed" ou "adds/fixes/changes".
- Ne mettez pas la première lettre de la ligne de résumé en majuscule.
- N'ajoutez pas de point (.) à la fin de la ligne de résumé.
2020-06-25 12:51:21 +03:00
< a name = "translations" > < / a >
## 7. Traductions
Ce document est disponible dans les langues suivantes :
- [Anglais ](../CONTRIBUTING.md )
- [Français ](./CONTRIBUTING.french.md )
2019-04-15 11:16:32 +03:00
(Credits: Certaines sections sont adaptées de https://github.com/PostgREST/postgrest/blob/master/.github/CONTRIBUTING.md)
2019-11-06 10:39:35 +03:00