Skip to content

Commit e13d90f

Browse files
Readme d'introduction avec lien
1 parent 0641f59 commit e13d90f

File tree

1 file changed

+17
-40
lines changed

1 file changed

+17
-40
lines changed

README.md

Lines changed: 17 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,30 @@
1-
# Comment faire ? #
1+
# Pour traduire la documentation de vue-router
22

3-
- [Pour savoir ce qu'il reste à traduire c'est par ici](https://github.com/vuejs-fr/vue-router/issues/1)
3+
### Workflow de travail
44

5-
Pour tous ceux qui souhaitent traduire les page de la doc officielle en français :
5+
Cette branche de travail `working` est volontairement mise en avant et doit uniquement être mise à jour dans le sens :
66

7-
## Conseils ##
7+
`vuejs/vue-router:dev` --> `vuejs-fr/vue-router:working`.
88

9-
> Si vous avez **beaucoup de temps** à consacrer à cette tâche par jour, **traduisez les premières pages** du guide.
10-
> Si vous avez **peu de temps** à consacrer à cette tâche par jour, **traduisez des pages plus éloignées** dans le guide, ou les pages des autres dossiers.
9+
Nous traduisons les fichiers directement dans le dossier `en` sans les renommer. Cela permet lors de la mise à jour de la documentation via l'utilisation des commandes :
1110

11+
```
12+
git fetch upstream
13+
git merge upstream/master
14+
```
1215

13-
### Important ###
16+
d'obtenir des conflits **sur les pages déjà traduites** et ainsi maintenir la documentation à jour en fonction des modifications à travers **les documents déjà traduits**.
1417

15-
Il faut conserver le même nombre de lignes entre le fichier original et le fichier traduit et s'assurer que chaque numéro de ligne original corresponde à son numéro de ligne traduit. Cela nous permettra de suivre plus facilement les pans de texte qui ont changés dans le futur ou même d'avoir version EN/FR en concordance dans nos pulls request ligne par ligne — ce qui est plus pratique pour les reviews.
18+
### Traduction
1619

17-
## Étapes ##
20+
Pour savoir ce qui est [en cours de traduction](https://github.com/vuejs-fr/vue-router/issues/1) ou [comment traduire un fichier](https://github.com/vuejs-fr/vue-router/issues/2), référez vous aux issues correspondantes.
1821

19-
### 1. Informer
22+
### Reverssement
2023

21-
Dites ici que vous allez entreprendre la traduction d'une page. Éditez le premier post et changez l'état de la liste si vous en avez le droit.
24+
Quand un fichier traduit est validé par pull request, on le met à jour dans le dossier `fr` de `vuejs-fr/vue-router:dev` puis on propose une pull request au site principal :
2225

23-
### 2. Faire un fork
26+
`vuejs-fr/vue-router:dev` --> `vuejs/vue-router:dev`
2427

25-
Faites un fork du dépôt `vuejs-fr/vue-router:working` (ce dépôt) vers `{your-username}/vuejs.org:working` (chez vous).
28+
ainsi le dossier officiel hébergeant la documentation possède bien le dossier `fr` en français et le dossier `en` en anglais.
2629

27-
### 3. Créer une branche
28-
29-
Créez une nouvelle branche {branch} dédiée spécifiquement au changement de votre fichier.
30-
31-
#### 4. Débuter la traduction
32-
33-
Commencez à traduire votre fichier directement depuis `en` pour pouvoir effectuer au moins un premier commit.
34-
35-
#### 5. Demander de l'aide
36-
37-
Faites une pull request depuis votre branche de fork `{your-username}/vue-router:{branch}` vers notre branche de dépôt `vuejs-fr/vue-router:working` pour que tout le monde puisse garder un œil sur l'avancée de votre traduction et que vous puissiez éventuellement demander des conseils. Assignez (*assignees*) vous cette pull request.
38-
39-
#### 6. Réclamer des reviews
40-
41-
Quand votre traduction est assez mûr pour une review, affectez des personnes en tant que reviewer (probablement celles qui vous auront aidé lors de la traduction) pour qu'elles sachent qu'elles peuvent consacrer un temps plus conséquent à la relecture minutieuse de votre travail.
42-
43-
#### 7. Itérez les ajustements
44-
45-
De la même manière qu'avant review votre traduction a été mis à jour au fur et à mesure de vos commits sur la pull request ; vous mettez à jour maintenant les remarques de review pour solidifier votre travail toujours avec des commits. Au moins 3 relecteurs sont recommandés.
46-
47-
#### 8. Merger
48-
49-
Une fois tout en ordre et que toutes les reviews sont approuvées vous pouvez merger votre travail. Il sera ensuite reverser sur la branche `vuejs-fr/vue-router:dev` dans le dossier `fr` et proposer en pull request au repository officiel `vuejs/vue-router:dev`.
50-
51-
## Voir le résultat sur le site https://router.vuejs.org/fr/
52-
53-
La monter en production n'est pas de notre ressort, soyez patient !
30+
Note : il peut être intéressant de faire une pull request par ficher validé et donc de créer une branche dérivée de `vuejs-fr/vue-router:dev` pour faire la pull request (`vuejs-fr/vue-router:dev` --> `vuejs-fr/vue-router:only_one_changed_file_from_master` --> `vuejs/vue-router:dev`)

0 commit comments

Comments
 (0)