Awesome

This cheat sheet summarizes 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.

List of available languages:

• ‎العربية
• English
• Català
• Deutsch
• Español
• پارسی
• Français
• Bahasa Indonesia
• Italiano
• 日本語
• Português
• Русский
• සිංහල
• Türkçe
• 简体中文
• 繁體中文

A language is missing? Want to improve this cheat sheet? Contributions are welcome!

A PDF version of this cheat sheet is available here.

1. 🎢 Preparation step

Your project must be stable enough with the minimum viable features in order to hook users.

Choose a name that users can easily remember.

The README is the first thing your visitors will see. Make it simple, pretty and easy to read. Here is a list of beautiful READMEs.

Identify your project's strengths and make sure visitors see them first.

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

You'll probably lose visitors if your project is not user-friendly.

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 with creating a clean documentation in a simple way.

2. 📢 Spread the word about your hard works

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.

Tell the World about your awesome work! Publish it on social media and other specialized platforms:

• Twitter
• Linkedin
• Facebook
• Reddit
• Dev.to
• Lobsters
• Hacker News
• Product Hunt
• Beta page
• Human Coders

Write articles about your project. Purpose can be the technical stack you used, how your project works, problems you encountered, etc. Post it to publishing platforms:

• medium
• dev.to

Presenting your project at conferences or meetups is a good way to improve its visibility.

Recording a video is not an easy exercise. However, it's probably the most efficient way to make your project famous.

Don't publish during holiday periods or weekends. The best time to publish on social networks is usually mid-week.

Don't publish twice on the same platform. It will be considered as spam and it might cause bad publicity for your project.

3. 🤝 Keep your users

Maintain and improve your project with new releases and generate changelogs.

Do not let issues stay open without a single response. Be nice with people that took the time to open issues. 😉

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.

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:

• vuepress (contributors README section)
• Rythm.js (random highlighted contributor on demo page)

Github issues are not always the best way to communicate with your users. If necessary, you can use chat platforms to discuss with them:

• Discord
• Slack
• Gitter

User feedback is the best way to improve your project. They probably have features and ideas that could make your project better.

Visitors will trust your project if they see concrete use cases and success stories, e.g., the vuepress gallery.

🙏 Show your support

⭐️ this repository if this cheat sheet helped you!

❤️ Contributors

Thanks go to these wonderful people:

This project follows the all-contributors specification. Contributions of any kind welcome!