3.2 KiB
Cheat sheet : Comment promouvoir un projet open-source ?
Ce cheet sheet résume les étapes importantes à suivre pour promouvoir un projet open-source dans les meilleurs conditions. Il est possible d’afficher des informations supplémentaires pour un élément de la liste en cliquant dessus.
Langages disponibles :
Une langue est manquante ? Vous pensez qu'il est possible d'améliorer ce cheat sheet ? Les contributions sont les bienvenues !
1. 🎢 Étape de préparation
😎 Choisir un nom cool pour son projet
Choisissez un nom que vos visiteurs pourront facilement retenir.
💅 Soigner la présentation du README
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.
💪 Mettre en avant les points fort du projet
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.
✨ Fournissez une démo du projet
Vos visiteurs voudront rapidement comprendre les tenants et aboutissements de votre projet. Comment ça fonctionne et comment l'utiliser. Fournir une démo est une excellente manière de satisfaire vos visiteurs. La démo peut être sous forme :
- un GIF animé
- d'un lien vers un démo en ligne
👌 L'installation doit être simplissime
Vous perdrez probablement vos visiteurs si votre projet n'est pas simple à installer.
📘 Creer un documentation soigner et bien structurer
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 helps you creating clean documentations in a simple way.
Creer un bonne documentation est probablement l'étape la plus importante. Si vous avez une petite documentation il vous sera possible de l'inclure dans votre README. Si celle-ci est volumineuse, le mieux sera de l'extraire vers une application web séparée. Certain projets open source comme vuepress peuvent vous aider à très vite créer un documentation propre et efficace.