2019-08-22 10:04:38 +02:00
< p align = "center" >
< img alt = "oss image" src = "./imgs/zoss-logo.svg" height = "200px" width = "200px" >
< / p >
2019-08-23 15:07:22 +02:00
< p align = "center" >
< a href = "https://twitter.com/intent/tweet?text=How%20to%20promote%20your%20open-source%20projects&url=https://github.com/zenika-open-source/open-source-promotion-cheat-sheet&hashtags=OpenSource,CheatSheet" >
< img alt = "tweet" src = "https://img.shields.io/twitter/url/https/twitter?label=Share%20on%20twitter&style=social" target = "_blank" / >
< / a >
< / p >
< h1 align = "center" > Open source promotion cheat sheet < / h1 >
2019-08-01 18:19:33 +02:00
2019-08-23 15:07:22 +02:00
> This cheat sheet summarize important steps you should follow to promote your open-source project in the best conditions. You can click items to expand and get more information from a topic.
2019-08-01 18:12:17 +02:00
2019-08-15 19:26:00 +02:00
List of availables languages:
2019-08-19 13:13:50 +02:00
2019-08-15 19:26:00 +02:00
- [English ](./README.md )
- [Français ](./README-fr.md )
2019-08-24 10:23:05 +02:00
A language is missing? Want to improve this cheat sheet? [Contributions are welcome ](./CONTRIBUTING.md ) !
2019-08-22 10:04:38 +02:00
2019-08-15 19:26:00 +02:00
## 1. 🎢 Preparation step
2019-08-19 13:13:50 +02:00
2019-08-19 16:18:11 +02:00
< br / >
< details >
< summary > 😎 Choose a cool name for your project< / summary >
< p >
2019-08-26 10:12:10 +02:00
> Choose a name users can easily remember.
2019-08-19 16:18:11 +02:00
< / p >
< / details >
< details >
< summary > 💅 Make your README pretty< / summary >
< p >
2019-08-24 10:23:05 +02:00
> 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).
2019-08-19 16:18:11 +02:00
< / p >
< / details >
< details >
< summary > 💪 Highlight strong points of your project < / summary >
< p >
2019-08-20 16:12:28 +02:00
> Identify your project strengths and make sure visitors see them at first.
2019-08-19 16:18:11 +02:00
< / p >
< / details >
< details >
< summary > ✨ Provide a demo of your project< / summary >
< p >
2019-08-19 13:13:50 +02:00
2019-08-20 16:12:28 +02:00
> 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:
2019-08-23 15:07:22 +02:00
>
> - An animated GIF demonstrating how your project works
> - A link to a live demo
2019-08-19 13:13:50 +02:00
2019-08-20 16:12:28 +02:00
< / p >
2019-08-19 16:18:11 +02:00
< / details >
2019-08-19 13:13:50 +02:00
2019-08-19 16:18:11 +02:00
< details >
< summary > 👌 Insall/Usage must be super easy< / summary >
< p >
2019-08-19 13:13:50 +02:00
2019-08-24 10:23:05 +02:00
> You'll probably lost visitors if your project is not user friendly.
2019-08-19 13:13:50 +02:00
2019-08-20 16:12:28 +02:00
< / p >
2019-08-19 16:18:11 +02:00
< / details >
2019-08-19 13:13:50 +02:00
2019-08-19 16:18:11 +02:00
< details >
< summary > 📘 Create a clean and well structured documentation< / summary >
< p >
2019-08-19 13:13:50 +02:00
2019-08-24 10:23:05 +02:00
> 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) helps you creating clean documentations in a simple way.
2019-08-19 16:18:11 +02:00
< / p >
< / details >
< br / >
2019-08-19 13:13:50 +02:00
## 2. 📢 Spread the word about your hard works
2019-08-19 16:18:11 +02:00
< br / >
< details >
2019-08-21 14:47:53 +02:00
< summary > ⭐ Make your project trustable before publishing to social networks< / summary >
2019-08-19 16:18:11 +02:00
< p >
2019-08-24 10:23:05 +02:00
> Most visitors will check how many stars the project got 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 medias.
2019-08-19 16:18:11 +02:00
< / p >
< / details >
< details >
< summary > ↗️ Share the project on social medias an specialized platforms< / summary >
< p >
2019-08-20 16:12:28 +02:00
> Tell the world about your awesome work! Publish on social medias and specialized platforms:
2019-08-20 20:24:07 +02:00
>
> - [Twitter](https://twitter.com)
> - [Linkedin](https://www.linkedin.com/)
> - [Facebook](https://www.facebook.com/)
> - [Reddit](https://www.reddit.com/)
> - [Dev.to](https://dev.to/)
> - [Lobsters](https://lobste.rs/)
> - [Hacker News](https://news.ycombinator.com/)
> - [Product Hunt](https://www.producthunt.com/)
> - [Beta page](https://betapage.co/)
> - [Human Coders](https://news.humancoders.com/)
2019-08-19 16:18:11 +02:00
< / p >
< / details >
< details >
< summary > 📃 Write articles that mention your project< / summary >
< p >
2019-08-24 10:23:05 +02:00
> 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:
>
> - [medium](https://medium.com/)
> - [dev.to](https://dev.to/)
2019-08-19 16:18:11 +02:00
< / p >
< / details >
< details >
< summary > 🎤 Present your project at conferences/meetups< / summary >
< p >
2019-08-19 13:13:50 +02:00
2019-08-20 16:12:28 +02:00
> Presenting your project at conferences or meetups is a good way to improve its visibility.
2019-08-19 13:13:50 +02:00
2019-08-19 16:18:11 +02:00
< / p >
< / details >
2019-08-19 13:13:50 +02:00
2019-08-19 16:18:11 +02:00
< details >
< summary > 🎥 Record and publish videos presenting your project, how it works, etc
< / summary >
< p >
2019-08-19 13:13:50 +02:00
2019-08-20 16:12:28 +02:00
> Recording a video is not an easy execise. However it's probably the most efficient way to make your project famous.
2019-08-19 13:13:50 +02:00
2019-08-19 16:18:11 +02:00
< / p >
< / details >
2019-08-19 13:13:50 +02:00
2019-08-19 16:18:11 +02:00
< details >
< summary > 🕐 Choose the best time to publish on social medias< / summary >
< p >
2019-08-19 13:13:50 +02:00
2019-08-19 16:18:11 +02:00
> Don't publish during holidays period or weekends. Usually the best time to publish on social networks is mid-week.
< / p >
< / details >
< details >
< summary > 🗑 Don't spam platforms with your promotion< / summary >
< p >
2019-08-22 10:04:38 +02:00
> Don't publish twice on the same platform. It will be considered as spam and might cause bad publicity for your project.
2019-08-19 16:18:11 +02:00
< / p >
< / details >
< br / >
2019-08-19 13:13:50 +02:00
## 3. 🤝 Keep your users
2019-08-19 16:18:11 +02:00
< br / >
< details >
< summary > 🆕 Try to regularly release new versions of your project< / summary >
< p >
2019-08-24 10:23:05 +02:00
> Maintain and improve your project with new releases and generate changelogs.
2019-08-19 16:18:11 +02:00
< / p >
< / details >
< details >
< summary > ❗ Maintain your project, process opened issues< / summary >
< p >
2019-08-20 16:12:28 +02:00
> Do not let opened issues without response. Be nice with people that took time to open issues 😉
2019-08-19 16:18:11 +02:00
< / p >
< / details >
< details >
< summary > 🙏 Invite users to contribute< / summary >
< p >
2019-08-24 10:23:05 +02:00
> 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).
2019-08-19 16:18:11 +02:00
< / p >
< / details >
< details >
< summary > 🏆 Reward contributors< / summary >
< p >
2019-08-24 10:23:05 +02:00
> 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 (ex: [vuepress contributors section](https://github.com/vuejs/vuepress#code-contributors)).
2019-08-19 16:18:11 +02:00
< / p >
< / details >
< details >
< summary > 💬 Open a community chat platform< / summary >
< p >
2019-08-24 10:23:05 +02:00
> Github issues are not always the best way to communicate with your users. If necessary, you can use chat platforms to discuss with them:
2019-08-23 15:07:22 +02:00
>
> - [Discord](https://discordapp.com)
> - [Slack](https://slack.com)
> - [Gitter](https://gitter.im/)
2019-08-19 16:18:11 +02:00
< / p >
< / details >
< details >
< summary > 🔙 Ask for feedback< / summary >
< p >
2019-08-20 16:12:28 +02:00
> User's feedback is the best way to improve your project. They probably have features and ideas that could make your project better.
2019-08-19 13:13:50 +02:00
2019-08-19 16:18:11 +02:00
< / p >
< / details >
2019-08-19 13:13:50 +02:00
2019-08-19 16:18:11 +02:00
< details >
< summary > ❤️ Open a use case gallery to show what users built with your project< / summary >
< p >
2019-08-19 13:13:50 +02:00
2019-08-20 16:12:28 +02:00
> Visitors will trust your project if they see concrete use case and success stories (ex: [vuepress gallery](https://vuepress.gallery/)).
2019-08-19 13:13:50 +02:00
2019-08-19 16:18:11 +02:00
< / p >
< / details >
2019-08-19 13:13:50 +02:00
2019-08-19 16:18:11 +02:00
< br / >