DEV Community

Cover image for 📄 Cheat sheet - How to promote your open-source project?
Franck Abgrall
Franck Abgrall

Posted on

51 14

📄 Cheat sheet - How to promote your open-source project?

You've created an open-source project? Great. But what happens when your project is mature enough to be used? You've put a lot of effort building an awesome project that could help the open-source community, but the reality is that if you don't spread the word about it, almost no one will see or use it.

Some colleagues and I went through a lot of open-source projects promotion these last months, and we found some good practices that helped our open-source projects gain popularity. And guess what? We created a cheat sheet to summarize everything we learned 😎.

👉 Click here to check out the cheat sheet on Github 👈

Is this article a way to promote this Github cheat sheet? Yes. See, you learn fast 😜.

Want to get started with open-source?

If you're new to the open-source world, I strongly recommend you to read these two articles first:

Show your support

Do not hesitate to support us if this helped you:

AWS Q Developer image

Your AI Code Assistant

Generate and update README files, create data-flow diagrams, and keep your project fully documented. Built to handle large projects, Amazon Q Developer works alongside you from idea to production code.

Get started free in your IDE

Top comments (7)

Collapse
 
fennecdjay profile image
Jérémie Astor • Edited

Thank you!
Plus your README is pretty nice!

I have a question thought...

What if you messed with some of the steps?


<details>
<summary>Some Title</summary>
<p>

> Some longer description that only appears if you click the title
</p>
</details>

Should figure in every Markdown overview.

Collapse
 
kefranabg profile image
Franck Abgrall

Thanks for you feedback!

All of those steps are not required. But the more you follow them the more you'll get visitors !

Collapse
 
jcubic profile image
Jakub T. Jankiewicz

It seems that you say nothing about SEO. I've created an article about the topic:
dev.to: SEO for Open Source Projects
Medium: SEO for Open Source Projects

I've linked to your git repo, and if you want to link to this project as well please link to Medium article (since dev.to is just a copy with canonical that point to medium).

Collapse
 
ianturton profile image
Ian Turton

I would add that when picking a name, try not to use a common word. For instance whenever I need to look up say the hovercraft presentation toolkit it is annoying to have to add several keywords to the name in the search so as not to see lots of presentations about hovercrafts.

Collapse
 
joeattardi profile image
Joe Attardi

This is great! 🎉

I've found that #2 is the hardest step. How do you promote the project without being spammy?

Collapse
 
kefranabg profile image
Franck Abgrall

Hey!

Yes, some of the steps of the section #2 like "Create a video" or "Present your project at conferences/meetups" implies some work, however they are not required.

Concerning spam, just avoid to publish twice one the same platform, or tweet every minute to do your project promotion ;)

Collapse
 
edyatl profile image
edyatl

Thanks for the cheat sheet. May you recommend some online boards to introduce new program and get feedback from community?

AWS Security LIVE!

Join us for AWS Security LIVE!

Discover the future of cloud security. Tune in live for trends, tips, and solutions from AWS and AWS Partners.

Learn More

AWS GenAI LIVE!

GenAI LIVE! is a dynamic live-streamed show exploring how AWS and our partners are helping organizations unlock real value with generative AI.

Tune in to the full event

DEV is partnering to bring live events to the community. Join us or dismiss this billboard if you're not interested. ❤️