|
|
||
|---|---|---|
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| README-fr.md | ||
| README.md | ||
How to promote my open-source? 🚀
This cheat sheet summarize important steps you should follow to promote your open-source project in the best conditions.
List of availables languages:
1. 🎢 Preparation step
😎 Choose a cool name for your project
Choose a name users can easily remember. It must not necessarly includes keywords related to the technology you're using within your project (ex: bento-starter).
💅 Make your README pretty
README is the first your user will see. Make it simple, pretty and easy to read. Here is a list of beautiful READMEs.
💪 Highlight strong points of your project
Identify your project strengths and make sure that visitors see them at first.
✨ Provide a demo of your project
README is the first your user will see. Make it simple, pretty and easy to read. Here is a list of beautiful READMEs.
👌 Insall/Usage must be super easy
You'll probably lost users if your project is not user friendly.
📘 Create a clean and well structured documentation
It is probably the most important step. If your have a small documentation, you can include it in your README. Otherwise, you should probably host it in a different website. Projects like vuepress helps you creating clean documentations in a simple way.
2. 📢 Spread the word about your hard works
⭐ Talk about your project to your friends and colleagues to get your first github stars before publishing to social networks
A minimum stars amount make your project more trustable than a zero star project. Ask people you know to support your project before doing a public annouccement on social medias.
↗️ Share the project on social medias an specialized platforms
Tell the world about your awesome project! Publish on social medias and specialized platforms:
📃 Write articles that mention your project
Write articles to talk about your project (purpose can be the technical stack you used, how your project works, problems you encountered, etc). Publish your articles to medium or dev.to.
🎤 Present your project at conferences/meetups
Presenting your project at conferences or meetupss is a good way to improve its visibility.
🎥 Record and publish videos presenting your project, how it works, etc
Like conferences, recording is not an easy execise, but it's a great way to get your project famous.
🕐 Choose the best time to publish on social medias
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. Generate changelogs is also a best practice to let your users know about changes.
❗ Maintain your project, process opened issues
Do not let opened issues without response. Be nice with people that took time to open an issue 😉
🙏 Invite users to contribute
A healthy project is a project with a community and contributors. Let your users know that you need helps by tagging some issues with
contribution welcomeorgood first issuelabels.
🏆 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 (which is probably the case), tweet about the contribution and mention the author (here is an example of tweet) open a
Contributorssection to your README in order to publicly thanks them (ex: vuepress contributors section).
💬 Open a community chat platform
Github issues are not always the best way to communicate with your users. Use chat platforms to discuss with them:
🔙 Ask for feedback
User's feedback is the best way to improve your project
❤️ Open a use case gallery to show what users built with your project
Visitors will trust your project if they see concrete use cases (ex: vuepress gallery)