Comment contribuer

Pour contribuer, il vous faudra un compte GitHub.
Si vous n’en avez pas, c'est très simple à créer : S’inscrire sur GitHub.

Si vous n’êtes pas développeur, 2 pages vous seront utiles sur ce dépôt :

• Le fichier des données : data.js
• La page des issues

Le fichier des données

Nommé data.js, il contient 3 types d’informations :

• un tableau nommé badWord qui contient les mots déconseillés ou mal écrits
• chaque caractère spécial analysé par SPTE
• un tableau nommé fileExtensions qui contient les extensions de fichiers pour lesquelles SPTE ne doit pas surligner le point lorsqu’il est accolé

C’est dans ce fichier que vous pouvez vérifier si SPTE traite ou non un mot mal écrit ou déconseillé que vous avez trouvé dans une traduction.
SPTE gère la casse des lettres, il n’est donc pas nécessaire de préciser l’orthographe en minuscule et en majuscule. Par contre il faut lui préciser le singulier et le pluriel : email et emails sont pour lui 2 mots différents.

C’est également dans ce fichier que vous pouvez vérifier si une extension de fichier est traitée par SPTE : pour rappel, le point ne doit pas être suivi par un caractère, SPTE se sert donc de cette liste d’extensions comme exceptions à cette règle.

La page des issues

La page des issues est celle sur laquelle vous pouvez :

• voir si une issue a déjà été créée
• voir les prochaines corrections ou évolutions qui sont prévues
• créer une issue

Comment créer une issue

En cliquant sur le bouton vert New Issue.
En écrivant en français.
Essayez de mettre un titre explicite afin que l’on puisse retrouver l’issue facilement.
Essayez surtout de mettre un exemple dans le corps du message afin qu’il soit simple à reproduire.
Si vous avez l’URL d’une traduction avec une erreur, indiquez-là. Si l’erreur a déjà été corrigée, reproduisez dans le message le texte qui posait problème.
Il peut s’agit d’un mot à ajouter à la liste des badWords, d’un caractère qu’SPTE n’analyse pas correctement, bref, plus vous laisserez de détails mieux ce sera.

Contribuer en tant que développeur

Firefox et Chrome offrent tous les 2 la possibilité de tester une extension en local, mais je vais décrire la méthode de Chrome car je lui trouve un avantage : il n’est pas nécessaire de rezipper l’archive entre chaque modification de code contrairement à Firefox.

Effectuez le processus de fork habituel pour la contribution à un projet GitHub. Lorsque vous aurez ainsi récupéré le code en local, lancez le navigateur Chrome et si vous utilisez SPTE dessus, désinstallez-le durant le temps de la contribution.

Utilisez le menu "Gérez les extensions" ou "Plus d’outils" > "Extensions" ou encore tapez l’adresse chrome://extensions/. Puis cliquez sur le bouton "Charger l’extension non empaquetée" : sélectionnez alors le dossier racine où se trouve le code d’SPTE et ça y est, vous pouvez tester SPTE en local et tester des modifications de code.

Chaque fois que vous modifierez le code en local, pensez juste à revenir sur cet écran des extensions pour cliquer sur la petite icône de rafraichissement symbolisée par une flèche tournante. Elle rafraichit l’extension chargée dans le navigateur, ensuite il faut rafraichir la page de traduction sur laquelle vous tester l’extension.