Skip to content

README-fr.md

Latest commit

 

History

History
145 lines (102 loc) · 4.79 KB

README-fr.md

File metadata and controls

145 lines (102 loc) · 4.79 KB

中文版 | 日本語版 | 한국어 | Русский | Português

Lignes directrices de projet · Les PRs sont les bienvenues

En développant un nouveau projet, c'est comme rouler sur un terrain vierge pour vous; le maintenir est un cauchemar sombre et tordu pour quelqu'un d'autre. Voici une liste de lignes directrices que nous avons trouvé, écrit et rassemblé que (nous pensons) fonctionne très bien avec la plupart des projets JavaScript ici àelsewhen. Si vous voulez partager une pratique exemplaire ou si vous pensez qu'une de ces lignes directrices devrait être supprimée,[n'hésitez pas à nous en faire part] (http://makeapullrequest.com).

1. Git

Git

1.1 Quelques règles Git

Il y a un ensemble de règles à garder à l'esprit :

1.2 Workflow Git

1.3 Ecrire de bon messages de commit

2. Documentation

Documentation

  • Utilisez ce modèle pour le README.md, ajoutez des sections non couverte si nécessaire.
  • Pour des projects ayant plus d'un repository, donnez des liens vers eux dans leurs fichiers `README.md' respectifs.
  • Gardez le README.md à jour au fur et à mesure que le projet évolue.
  • Commentez votre code. Essayez de le rendre aussi clair que possible ce que vous prévoyez dans chaque section majeure.
  • S'il y a une discussion ouverte à propos du code ou de l'approche que vous utilisez sur github ou stackoverflow, insérez le lien dans votre commentaire.
  • N'utiliez pas des commentaires comme une excuse pour écrire un mauvais code. Gardez votre code propre.
  • N'utiliez pas de code propre comme une excuse pour ne pas commentez du tout.
  • Gardez des commentaires pertinents à mesure que le code évolue.

3. Environments

Environments

3.1 Consistent dev environments:

3.2 Consistent dependencies:

4. Dependences

Github

5. Test

Testing

6. Structure et dénomination

Structure and Naming

7. Code style

Code style

7.1 Some code style guidelines

7.2 Enforcing code style standards

8. Logging

Logging

9. API

API

9.1 API design

_

9.2 API security

9.3 API documentation

10. Licence

Licensing

Assurez-vous d'utiliser les ressources que vous avez le droit d'utiliser. Si vous utilisez des bibliothèques, n'oubliez pas de chercher MIT, Apache ou BSD mais si vous les modifiez, jetez un oeil aux détails de la licence. Des images et des vidéos protégées par le droit d'auteur peuvent causer des problèmes juridiques.

Sources: RisingStack Engineering, Mozilla Developer Network, Heroku Dev Center, Airbnb/javascript, Atlassian Git tutorials, Apigee, Wishtack

Icones par icons8