diff --git a/README-fr.md b/README-fr.md index c27f632..c706c4b 100644 --- a/README-fr.md +++ b/README-fr.md @@ -10,7 +10,7 @@
> Assurez-vous que votre projet soit stable et possède un minimum de fonctionnalités intéressantes pour accrocher les visiteurs. @@ -33,7 +33,7 @@ Une langue est manquante ? Vous pensez qu'il est possible d'améliorer ce cheat
> Choisissez un nom que vos visiteurs pourront facilement retenir. @@ -42,49 +42,49 @@ Une langue est manquante ? Vous pensez qu'il est possible d'améliorer ce cheat
-> Le README est la première choses que les visiteurs verront sur la page de votre projet. Travaillez la présentation pour qu'elle soit simple, jolie et agréable à lire. [Vous trouverez des exemples de README soignés ici.](https://github.com/matiassingers/awesome-readme) +> Le README est la première chose que les visiteurs verront sur la page de votre projet. Travaillez la présentation pour qu'elle soit simple, jolie et agréable à lire. [Vous trouverez des exemples de README soignés ici.](https://github.com/matiassingers/awesome-readme)
-> Identifiez les points forts de votre projet et mettez les en avant de manière à ce que ce soit la première chose que voient vos visiteurs. +> Identifiez les points forts de votre projet et mettez-les en avant de manière à ce que ce soit la première chose que voient vos visiteurs.
-> Vos visiteurs voudront comprendre rapidement à quel besoin répond votre projet et comment il fonctionne. Mettre une démo à disposition est un excellente moyen de satisfaire vos visiteurs. Le format de la démo peut être : +> Vos visiteurs voudront comprendre rapidement à quel besoin répond votre projet et comment il fonctionne. Mettre une démo à disposition est un excellent moyen de satisfaire vos visiteurs. Le format de la démo peut être : > > - un GIF animé -> - un lien vers un démo en ligne +> - un lien vers une démo en ligne
-> Vous risquez de perdre des visiteurs si le projet n'est pas simple à installer/utiliser. +> Vous risquez de perdre des visiteurs si le projet n'est pas simple à installer ou à utiliser.
-> Créer un bonne documentation est probablement l'étape la plus importante. Si votre documentation n'est pas longue, vous pouvez l'inclure directement dans votre README. Si celle-ci est volumineuse, le mieux sera de l'héberger sur un site différent. Certains projets open-source comme [vuepress](https://v1.vuepress.vuejs.org) permettent de créer rapidement une jolie documentation. +> Créer une bonne documentation est probablement l'étape la plus importante. Si votre documentation n'est pas longue, vous pouvez l'inclure directement dans votre README. Si celle-ci est volumineuse, le mieux sera de l'héberger sur un site différent. Certains projets open-source comme [vuepress](https://v1.vuepress.vuejs.org) permettent de créer rapidement une jolie documentation.
-> La plupart des visiteurs regarderont le nombre de stars du projet avant de l'utiliser. Plus votre projet possède un nombre important stars, plus son indice de fiabilité sera élevé. N'hésitez pas à demander à vos proches, collègues et amis de vous aider à améliorer la crédibilité de votre projet en ajoutant une star. +> La plupart des visiteurs regarderont le nombre de stars du projet avant de l'utiliser. Plus votre projet possède un nombre important de stars, plus son indice de fiabilité sera élevé. N'hésitez pas à demander à vos proches, collègues et amis de vous aider à améliorer la crédibilité de votre projet en ajoutant une star.
-> Voici quelques plateformes sur lesquelles vous pourriez partager votre travail : +> Voici quelques plateformes sur lesquelles vous pourriez partager votre travail : > > - [Twitter](https://twitter.com) > - [Linkedin](https://www.linkedin.com/) @@ -125,10 +125,10 @@ Une langue est manquante ? Vous pensez qu'il est possible d'améliorer ce cheat
-> Écrivez des articles et citez votre projet. Le sujet de l'article peut être lié à la stack technique que vous avez utilisée, les problèmes que vous avez rencontré, etc. Postez sur les plateformes de publication : +> Écrivez des articles et citez votre projet. Le sujet de l'article peut être lié à la stack technique que vous avez utilisée, les problèmes que vous avez rencontrés, etc. Postez sur les plateformes de publication : > > - [medium](https://medium.com/) > - [dev.to](https://dev.to/) @@ -137,7 +137,7 @@ Une langue est manquante ? Vous pensez qu'il est possible d'améliorer ce cheat
> La présentation de votre projet à des conférences et meetups est un excellent moyen d'améliorer sa visibilité. @@ -146,16 +146,16 @@ Une langue est manquante ? Vous pensez qu'il est possible d'améliorer ce cheat
-> Enregistrez une vidéo n'est un exercice facile, cependant c'est l'un des moyens les plus efficaces pour rendre votre projet populaire. +> Enregistrez une vidéo n'est pas un exercice facile, cependant c'est l'un des moyens les plus efficaces pour rendre votre projet populaire.
> Habituellement, le meilleur moment pour lancer une communication est en milieu de semaine. Ne faites pas de communication pendant les périodes de vacances ou le week-end. @@ -164,7 +164,7 @@ Une langue est manquante ? Vous pensez qu'il est possible d'améliorer ce cheat
> Ne publiez pas deux fois sur la même plateforme. Votre communication pourra être considérée comme du spam et causer de la mauvaise publicité pour votre projet.
@@ -179,7 +179,7 @@ Une langue est manquante ? Vous pensez qu'il est possible d'améliorer ce cheat
> Maintenez et améliorez votre projet en publiant de nouvelles versions. N'oubliez pas de générer les changelogs associés.
@@ -188,28 +188,28 @@ Une langue est manquante ? Vous pensez qu'il est possible d'améliorer ce cheat
-> Ne laissez pas les issues sans réponses. Soyez courtois et sympathique avec les personnes qui ont pris le temps d'ouvrir des issues. 😉
+> Ne laissez pas les issues sans réponse. Soyez courtois et sympathique avec les personnes qui ont pris le temps d'ouvrir des issues. 😉
-> Un projet en bonne santé est un projet qui possède une communauté et des contributeurs. Montrez à vos utilisateurs que leur aide est la bienvenue en taggant certaines issues avec les labels `contribution welcome` ou `good first issue`. [Vous trouverez plus d'information sur les labels en cliquant ici.](https://help.github.com/en/articles/about-labels).
+> Un projet en bonne santé est un projet qui possède une communauté et des contributeurs. Montrez à vos utilisateurs que leur aide est la bienvenue en taggant certaines issues avec les labels `contribution welcome` ou `good first issue`. [Vous trouverez plus d'information sur les labels en cliquant ici.](https://help.github.com/en/articles/about-labels)
-> Certains projets open-source comme [gatsby](https://github.com/gatsbyjs/gatsby) récompensent leurs contributeurs avec des goodies. Si vous n'en n'avez pas les moyens, faites une publication (sur twitter ou d'autres plateformes) qui mentionne la contribution et son auteur afin de le remercier (ex: [Post sur twitter](https://twitter.com/FranckAbgrall/status/1139470547492978688)). Vous pouvez aussi ouvrir une section `Contributors` sur votre README afin d'afficher publiquement votre gratitude envers vos contributeurs ou encore les mettre en avant sur le site/la documentation de votre projet.
+> Certains projets open-source comme [gatsby](https://github.com/gatsbyjs/gatsby) récompensent leurs contributeurs avec des goodies. Si vous n'en n'avez pas les moyens, faites une publication (sur twitter ou d'autres plateformes) qui mentionne la contribution et son auteur afin de le remercier (ex. : [Post sur twitter](https://twitter.com/FranckAbgrall/status/1139470547492978688)). Vous pouvez aussi ouvrir une section `Contributors` sur votre README afin d'afficher publiquement votre gratitude envers vos contributeurs ou encore les mettre en avant sur le site ou la documentation de votre projet.
>
> - [vuepress (section contributeurs dans le README)](https://github.com/vuejs/vuepress#code-contributors)
> - [Rythm.js (Mise en avant de manière aléatoire d'un contributeur sur la page de démo)](https://okazari.github.io/Rythm.js/)
@@ -218,7 +218,7 @@ Une langue est manquante ? Vous pensez qu'il est possible d'améliorer ce cheat
> Les issues Github ne sont pas toujours la meilleure manière de communiquer avec vos utilisateurs. Si nécessaire, vous pouvez ouvrir un chat pour discuter avec eux :
@@ -231,7 +231,7 @@ Une langue est manquante ? Vous pensez qu'il est possible d'améliorer ce cheat
> Les retours des utilisateurs sont un excellent moyen d'améliorer votre projet. Vos utilisateurs ont probablement un tas d'idées qui pourraient rendre votre projet meilleur.
@@ -241,10 +241,10 @@ Une langue est manquante ? Vous pensez qu'il est possible d'améliorer ce cheat
-> Les visiteurs accorderont plus facilement leur confiance si ils voient des cas concrets d'utilisation (ex: [vuepress gallery](https://vuepress.gallery/)).
+> Les visiteurs accorderont plus facilement leur confiance s'ils voient des cas concrets d'utilisation (ex. : [vuepress gallery](https://vuepress.gallery/)).
🆕 Mettre régulièrement à jour le projet
+🆕 Mettre régulièrement à jour le projet.
❗ Maintenir le projet et traiter les issues ouvertes
+❗ Maintenir le projet et traiter les issues ouvertes.
🙏 Inviter les utilisateurs à contribuer
+🙏 Inviter les utilisateurs à contribuer.
🏆 Récompenser les contributeurs
+🏆 Récompenser les contributeurs.
💬 Ouvrir un chat pour la communauté du projet
+💬 Ouvrir un chat pour la communauté du projet.
🔙 Demander des retours utilisateurs
+🔙 Demander des retours utilisateurs.
❤️ Montrer ce que les autres utilisateurs ont créé avec votre projet
+❤️ Montrer ce que les autres utilisateurs ont créé avec votre projet.
> Your project must be stable enough with minimum viables features in order to hook users. @@ -34,7 +34,7 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
> Choose a name users can easily remember. @@ -43,7 +43,7 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
> README is the first thing your vistors will see. Make it simple, pretty and easy to read. [Here is a list of beautiful READMEs](https://github.com/matiassingers/awesome-readme). @@ -52,7 +52,7 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
> Identify your project strengths and make sure visitors see them first. @@ -61,7 +61,7 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
> Vistors will want to quickly understand the purpose of your project, how it works and how to use it. Providing a demo is the best way to satisfy users. It could be: @@ -73,16 +73,16 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
-> You'll probably lose visitors if your project is not user friendly. +> You'll probably lose visitors if your project is not user-friendly.
> Creating a good documentation is probably the most important step. If you have a small documentation, you can include it within your README. Otherwise, you should probably host it in a separate website. Some open-source projects like [vuepress](https://v1.vuepress.vuejs.org) can help you creating clean documentations in a simple way.
@@ -97,16 +97,16 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
-> Most visitors will check how many stars the project has before considering using it. A minimum amount of stars makes your project more trustable than a project with zero stars. This is why you should ask people you know to support your project before doing a public announcement on social media.
+> Most visitors will check how many stars the project has before considering using it. A minimum amount of stars makes your project more trustable than a project with zero star. This is why you should ask people you know to support your project before doing a public announcement on social media.
> Tell the world about your awesome work! Publish on social media and specialized platforms:
@@ -126,7 +126,7 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
> Write articles about your project. Purpose can be the technical stack you used, how your project works, problems you encountered, etc. Post to publishing platforms:
@@ -137,7 +137,7 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
> Presenting your project at conferences or meetups is a good way to improve its visibility.
@@ -146,7 +146,7 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
@@ -156,7 +156,7 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
> Don't publish during holidays period or weekends. Usually the best time to publish on social networks is mid-week.
@@ -165,7 +165,7 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
> Don't publish twice on the same platform. It will be considered as spam and might cause bad publicity for your project.
@@ -180,7 +180,7 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
> Maintain and improve your project with new releases and generate changelogs.
@@ -189,16 +189,16 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
-> Do not let opened issues without response. Be nice with people that took time to open issues 😉
+> Do not let opened issues without response. Be nice with people that took time to open issues. 😉
> A healthy project is a project with a community and contributors. Let your users know that you need help by tagging some issues with `contribution welcome` or `good first issue` labels. [See github labels](https://help.github.com/en/articles/about-labels).
@@ -207,10 +207,10 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
-> Be nice with people that helped you! Some open-source projects like [gatsby](https://github.com/gatsbyjs/gatsby) reward contributors with goodies. If you can't afford that, do a public post (on twitter or other platforms) about the contribution and mention the author ([here is an example of public thanks](https://twitter.com/FranckAbgrall/status/1139470547492978688)). Open a `Contributors` section in your README to publicly thanks them or showcase them on your project documentation/website. Here some examples :
+> Be nice with people that helped you! Some open-source projects like [gatsby](https://github.com/gatsbyjs/gatsby) reward contributors with goodies. If you can't afford that, do a public post (on twitter or other platforms) about the contribution and mention the author ([here is an example of public thanks](https://twitter.com/FranckAbgrall/status/1139470547492978688)). Open a `Contributors` section in your README to publicly thank them or showcase them on your project documentation or website. Here are some examples:
>
> - [vuepress (contributors README section)](https://github.com/vuejs/vuepress#code-contributors)
> - [Rythm.js (random highlighted contributor on demo page)](https://okazari.github.io/Rythm.js/)
@@ -219,7 +219,7 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
> Github issues are not always the best way to communicate with your users. If necessary, you can use chat platforms to discuss with them:
@@ -232,7 +232,7 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
> User feedback is the best way to improve your project. They probably have features and ideas that could make your project better.
@@ -241,10 +241,10 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
-> Visitors will trust your project if they see concrete use case and success stories (ex: [vuepress gallery](https://vuepress.gallery/)).
+> Visitors will trust your project if they see concrete use cases and success stories, e.g., [the vuepress gallery](https://vuepress.gallery/)).
⭐ Make your project trustable before publishing it on social networks
+⭐ Make your project trustable before publishing it on social networks.
↗️ Share the project on social media and specialized platforms
+↗️ Share the project on social media and specialized platforms.
📃 Write articles that mention your project
+📃 Write articles that mention your project.
🎤 Present your project at conferences/meetups
+🎤 Present your project at conferences/meetups.
🎥 Record and publish videos presenting your project, how it works, etc
+
🎥 Record and publish videos presenting your project, how it works, etc.
🕐 Choose the best time to publish on social media
+🕐 Choose the best time to publish on social media.
🗑 Don't spam platforms with your promotion
+🗑 Don't spam platforms with your promotion.
🆕 Try to regularly release new versions of your project
+🆕 Try to regularly release new versions of your project.
❗ Maintain your project, process opened issues
+❗ Maintain your project, process opened issues.
🙏 Invite users to contribute
+🙏 Invite users to contribute.
🏆 Reward contributors
+🏆 Reward contributors.
💬 Open a community chat platform
+💬 Open a community chat platform.
🔙 Ask for feedback
+🔙 Ask for feedback.
❤️ Open a use case gallery to show what users built with your project
+❤️ Open a use case gallery to show what users built with your project.