deblan/open-source-promotion-cheat-sheet
1
1
Fork 0
Code Issues Pull requests Releases Wiki Activity

🎨 Removing marks

Browse source
This commit is contained in:
Franck 2019-09-04 17:49:43 +02:00
parent 64790de2e8
commit 435a9ffdeb
No known key found for this signature in database
GPG key ID: 65B68E022B5DB80D
2 changed files with 41 additions and 41 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
README-fr.md
View file

@ -24,7 +24,7 @@ Une langue est manquante ? Vous pensez qu'il est possible d'améliorer ce cheat
<br />
<details>
<summary>👌 S'assurer que le projet soit assez mature.</summary>
<summary>👌 S'assurer que le projet soit assez mature</summary>
<p>
> 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
</details>
<details>
<summary>😎 Choisir un nom cool pour son projet.</summary>
<summary>😎 Choisir un nom cool pour son projet</summary>
<p>
> Choisissez un nom que vos visiteurs pourront facilement retenir.
@ -42,7 +42,7 @@ Une langue est manquante ? Vous pensez qu'il est possible d'améliorer ce cheat
</details>
<details>
<summary>💅 Soigner la présentation du README.</summary>
<summary>💅 Soigner la présentation du README</summary>
<p>
> 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)
@ -51,7 +51,7 @@ Une langue est manquante ? Vous pensez qu'il est possible d'améliorer ce cheat
</details>
<details>
<summary>💪 Mettre en avant les points forts du projet.</summary>
<summary>💪 Mettre en avant les points forts du projet</summary>
<p>
> 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.
@ -60,7 +60,7 @@ Une langue est manquante ? Vous pensez qu'il est possible d'améliorer ce cheat
</details>
<details>
<summary>✨ Mettre une démo du projet à disposition.</summary>
<summary>✨ Mettre une démo du projet à disposition</summary>
<p>
> 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 :
@ -72,7 +72,7 @@ Une langue est manquante ? Vous pensez qu'il est possible d'améliorer ce cheat
</details>
<details>
<summary>👌 L'installation et l'utilisation du projet doivent être les plus simples possibles.</summary>
<summary>👌 L'installation et l'utilisation du projet doivent être les plus simples possibles</summary>
<p>
> Vous risquez de perdre des visiteurs si le projet n'est pas simple à installer ou à utiliser.
@ -81,7 +81,7 @@ Une langue est manquante ? Vous pensez qu'il est possible d'améliorer ce cheat
</details>
<details>
<summary>📘 Créer une documentation soignée et structurée.</summary>
<summary>📘 Créer une documentation soignée et structurée</summary>
<p>
> 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.
@ -96,7 +96,7 @@ Une langue est manquante ? Vous pensez qu'il est possible d'améliorer ce cheat
<br />
<details>
<summary>⭐ Mettre en confiance les futurs visiteurs avant de publier sur les réseaux sociaux.</summary>
<summary>⭐ Mettre en confiance les futurs visiteurs avant de publier sur les réseaux sociaux</summary>
<p>
> 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.
@ -105,7 +105,7 @@ Une langue est manquante ? Vous pensez qu'il est possible d'améliorer ce cheat
</details>
<details>
<summary>↗️ Partager le projet sur les réseaux sociaux et les plateformes spécialisées.</summary>
<summary>↗️ Partager le projet sur les réseaux sociaux et les plateformes spécialisées</summary>
<p>
> Voici quelques plateformes sur lesquelles vous pourriez partager votre travail :
@ -125,7 +125,7 @@ Une langue est manquante ? Vous pensez qu'il est possible d'améliorer ce cheat
</details>
<details>
<summary>📃 Écrire des articles en mentionnant le projet.</summary>
<summary>📃 Écrire des articles en mentionnant le projet</summary>
<p>
> É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 :
@ -137,7 +137,7 @@ Une langue est manquante ? Vous pensez qu'il est possible d'améliorer ce cheat
</details>
<details>
<summary>🎤 Présenter le projet à des conférences/meetups.</summary>
<summary>🎤 Présenter le projet à des conférences/meetups</summary>
<p>
> La présentation de votre projet à des conférences et meetups est un excellent moyen d'améliorer sa visibilité.
@ -146,7 +146,7 @@ Une langue est manquante ? Vous pensez qu'il est possible d'améliorer ce cheat
</details>
<details>
<summary>🎥 Enregistrer et publier des vidéos de présentation du projet.</summary>
<summary>🎥 Enregistrer et publier des vidéos de présentation du projet</summary>
<p>
> 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.
@ -155,7 +155,7 @@ Une langue est manquante ? Vous pensez qu'il est possible d'améliorer ce cheat
</details>
<details>
<summary>🕐 Choisir le meilleur moment pour publier sur les réseaux sociaux.</summary>
<summary>🕐 Choisir le meilleur moment pour publier sur les réseaux sociaux</summary>
<p>
> 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
</details>
<details>
<summary>🗑 Ne pas spammer les plateformes avec la promotion du projet.</summary>
<summary>🗑 Ne pas spammer les plateformes avec la promotion du projet</summary>
<p>
> 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
<br />
<details>
<summary>🆕 Mettre régulièrement à jour le projet.</summary>
<summary>🆕 Mettre régulièrement à jour le projet</summary>
<p>
> Maintenez et améliorez votre projet en publiant de nouvelles versions. N'oubliez pas de générer les changelogs associés.
@ -188,7 +188,7 @@ Une langue est manquante ? Vous pensez qu'il est possible d'améliorer ce cheat
</details>
<details>
<summary>❗ Maintenir le projet et traiter les issues ouvertes.</summary>
<summary>❗ Maintenir le projet et traiter les issues ouvertes</summary>
<p>
> Ne laissez pas les issues sans réponse. Soyez courtois et sympathique avec les personnes qui ont pris le temps d'ouvrir des issues. 😉
@ -197,7 +197,7 @@ Une langue est manquante ? Vous pensez qu'il est possible d'améliorer ce cheat
</details>
<details>
<summary>🙏 Inviter les utilisateurs à contribuer.</summary>
<summary>🙏 Inviter les utilisateurs à contribuer</summary>
<p>
> 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)
@ -206,7 +206,7 @@ Une langue est manquante ? Vous pensez qu'il est possible d'améliorer ce cheat
</details>
<details>
<summary>🏆 Récompenser les contributeurs.</summary>
<summary>🏆 Récompenser les contributeurs</summary>
<p>
> 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.
@ -218,7 +218,7 @@ Une langue est manquante ? Vous pensez qu'il est possible d'améliorer ce cheat
</details>
<details>
<summary>💬 Ouvrir un chat pour la communauté du projet.</summary>
<summary>💬 Ouvrir un chat pour la communauté du projet</summary>
<p>
> 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
</details>
<details>
<summary>🔙 Demander des retours utilisateurs.</summary>
<summary>🔙 Demander des retours utilisateurs</summary>
<p>
> 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,7 +241,7 @@ Une langue est manquante ? Vous pensez qu'il est possible d'améliorer ce cheat
</details>
<details>
<summary>❤️ Montrer ce que les autres utilisateurs ont créé avec votre projet.</summary>
<summary>❤️ Montrer ce que les autres utilisateurs ont créé avec votre projet</summary>
<p>
> Les visiteurs accorderont plus facilement leur confiance s'ils voient des cas concrets d'utilisation (ex. : [vuepress gallery](https://vuepress.gallery/)).

40
README.md
View file

@ -25,7 +25,7 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
<br />
<details>
<summary>👌 Make sure your project is mature enough.</summary>
<summary>👌 Make sure your project is mature enough</summary>
<p>
> 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
</details>
<details>
<summary>😎 Choose a cool name for your project.</summary>
<summary>😎 Choose a cool name for your project</summary>
<p>
> Choose a name users can easily remember.
@ -43,7 +43,7 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
</details>
<details>
<summary>💅 Make your README pretty.</summary>
<summary>💅 Make your README pretty</summary>
<p>
> 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
</details>
<details>
<summary>💪 Highlight strong points of your project.</summary>
<summary>💪 Highlight strong points of your project</summary>
<p>
> 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
</details>
<details>
<summary>✨ Provide a demo of your project.</summary>
<summary>✨ Provide a demo of your project</summary>
<p>
> 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,7 +73,7 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
</details>
<details>
<summary>👌 Install/Usage must be super easy.</summary>
<summary>👌 Install/Usage must be super easy</summary>
<p>
> You'll probably lose visitors if your project is not user-friendly.
@ -82,7 +82,7 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
</details>
<details>
<summary>📘 Create a clean and well structured documentation.</summary>
<summary>📘 Create a clean and well structured documentation</summary>
<p>
> 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,7 +97,7 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
<br />
<details>
<summary>⭐ Make your project trustable before publishing it on social networks.</summary>
<summary>⭐ Make your project trustable before publishing it on social networks</summary>
<p>
> 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.
@ -106,7 +106,7 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
</details>
<details>
<summary>↗️ Share the project on social media and specialized platforms.</summary>
<summary>↗️ Share the project on social media and specialized platforms</summary>
<p>
> 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
</details>
<details>
<summary>📃 Write articles that mention your project.</summary>
<summary>📃 Write articles that mention your project</summary>
<p>
> 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
</details>
<details>
<summary>🎤 Present your project at conferences/meetups.</summary>
<summary>🎤 Present your project at conferences/meetups</summary>
<p>
> Presenting your project at conferences or meetups is a good way to improve its visibility.
@ -156,7 +156,7 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
</details>
<details>
<summary>🕐 Choose the best time to publish on social media.</summary>
<summary>🕐 Choose the best time to publish on social media</summary>
<p>
> 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
</details>
<details>
<summary>🗑 Don't spam platforms with your promotion.</summary>
<summary>🗑 Don't spam platforms with your promotion</summary>
<p>
> 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
<br />
<details>
<summary>🆕 Try to regularly release new versions of your project.</summary>
<summary>🆕 Try to regularly release new versions of your project</summary>
<p>
> Maintain and improve your project with new releases and generate changelogs.
@ -189,7 +189,7 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
</details>
<details>
<summary>❗ Maintain your project, process opened issues.</summary>
<summary>❗ Maintain your project, process opened issues</summary>
<p>
> Do not let opened issues without response. Be nice with people that took time to open issues. 😉
@ -198,7 +198,7 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
</details>
<details>
<summary>🙏 Invite users to contribute.</summary>
<summary>🙏 Invite users to contribute</summary>
<p>
> 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,7 +207,7 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
</details>
<details>
<summary>🏆 Reward contributors.</summary>
<summary>🏆 Reward contributors</summary>
<p>
> 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:
@ -219,7 +219,7 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
</details>
<details>
<summary>💬 Open a community chat platform.</summary>
<summary>💬 Open a community chat platform</summary>
<p>
> 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
</details>
<details>
<summary>🔙 Ask for feedback.</summary>
<summary>🔙 Ask for feedback</summary>
<p>
> User feedback is the best way to improve your project. They probably have features and ideas that could make your project better.
@ -241,7 +241,7 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
</details>
<details>
<summary>❤️ Open a use case gallery to show what users built with your project.</summary>
<summary>❤️ Open a use case gallery to show what users built with your project</summary>
<p>
> Visitors will trust your project if they see concrete use cases and success stories, e.g., [the vuepress gallery](https://vuepress.gallery/)).