You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Identify your project strengths and make sure visitors see them first.
✨ Provide a demo of your project
Visitors 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:
An animated GIF demonstrating how your project works
A link to a live demo
👌 Install/Usage must be super easy
You'll probably lose visitors if your project is not user-friendly.
📘 Create a clean and well structured documentation
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 can help you creating clean documentation in a simple way.
2. 📢 Spread the word about your hard works
⭐ Make your project trustable before publishing it on social networks
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.
↗️ Share the project on social media and specialized platforms
Tell the World about your awesome work! Publish on social media and specialized platforms:
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:
Presenting your project at conferences or meetups is a good way to improve its visibility.
🎥 Record and publish videos presenting your project, how it works, etc
Recording a video is not an easy exercise. However it's probably the most efficient way to make your project famous.
🕐 Choose the best time to publish on social media
Don't publish during holidays period or weekends. Usually the best time to publish on social networks is mid-week.
🗑 Don't spam platforms with your promotion
Don't publish twice on the same platform. It will be considered as spam and might cause bad publicity for your project.
3. 🤝 Keep your users
🆕 Try to regularly release new versions of your project
Maintain and improve your project with new releases and generate changelogs.
❗ Maintain your project, process opened issues
Do not let opened issues without response. Be nice with people that took time to open issues. 😉
🙏 Invite users to contribute
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.
🏆 Reward contributors
Be nice with people that helped you! Some open source projects like 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). Open a Contributors section in your README to publicly thank them or showcase them on your project documentation or website. Here are some examples:
Promotion about OpenSource
1. 🎢 Preparation step
👌 Make sure your project is mature enough
😎 Choose a cool name for your project
💅 Make your README pretty
💪 Highlight strong points of your project
✨ Provide a demo of your project
👌 Install/Usage must be super easy
📘 Create a clean and well structured documentation
2. 📢 Spread the word about your hard works
⭐ Make your project trustable before publishing it on social networks
📃 Write articles that mention your project
🎤 Present your project at conferences/meetups
🎥 Record and publish videos presenting your project, how it works, etc
🕐 Choose the best time to publish on social media
🗑 Don't spam platforms with your promotion
3. 🤝 Keep your users
🆕 Try to regularly release new versions of your project
❗ Maintain your project, process opened issues
🙏 Invite users to contribute
🏆 Reward contributors
💬 Open a community chat platform
🔙 Ask for feedback
❤️ Open a use case gallery to show what users built with your project