DEV Community

Cover image for Take Your Github Repository To The Next Level 🚀️

Take Your Github Repository To The Next Level 🚀️

Younes Laaroussi on April 03, 2022

I’ve been using Github for a very long time now, and along the way I’ve been gathering a step-by-step guide on creating the perfect Github reposito...
Collapse
 
bennycode profile image
Benny Code •

You picked great live examples! Thank you very much for sharing.

What also makes a GitHub repository attractive to me is when they are using GitHub releases and proper changelogs. Example: github.com/mui/material-ui/release...

Using GitHub pages for API documentation is also important. Example: github.com/vazco/uniforms/tree/gh-...

Collapse
 
youneslaaroussi profile image
Younes Laaroussi • • Edited

Thank you for these suggestions! 👍
I will be updating the article, and giving you the credits!

Collapse
 
bennycode profile image
Benny Code •

Oh, that's cool! Thank you. 😊

Collapse
 
dhanushnehru profile image
Dhanush N •

You can add much more such as profile viewer count etc.

You can have a look at my GitHub repository as well regarding stats & github actions 🙂

Collapse
 
youneslaaroussi profile image
Younes Laaroussi •

Very interesting, thanks!

Collapse
 
jcubic profile image
Jakub T. Jankiewicz •

They are not actually for repositories only for profiles, it will look odd if you do the same on your project.

Collapse
 
dhruv194 profile image
Dhruv Mehta •

Damn this is really a great article. I know that readmes are important and they make the project even better. But here you mentioned a few things about which I was completely unaware of. Thanks for sharing!

Collapse
 
youneslaaroussi profile image
Younes Laaroussi •

I'm glad you liked it! 👍️

Collapse
 
paulmcgann profile image
Paul McGann •

Nice write up and something I will be using for future projects. There is another piece of screen recording software I thought useful to mention it is called Open Broadcaster Software (OBS) obsproject.com/. You can capture a whole screen or specific windows or a section of a screen. Best of all it is free and open source.

Collapse
 
youneslaaroussi profile image
Younes Laaroussi •

Thanks for the suggestion! 👍
I'll add it to the article and give you the credits for suggesting it.

Collapse
 
crunchstack profile image
CRUNCHSTACK •

Thanks for the tips, they are good points overall

Collapse
 
youneslaaroussi profile image
Younes Laaroussi • • Edited

I'm glad you liked it! 🤗

Collapse
 
hey_atharva profile image
Atharva Shirdhankar •

Awesome collection of tools for GitHub readme 🔥.

Collapse
 
youneslaaroussi profile image
Younes Laaroussi •

Thanks! 🤗

Collapse
 
vulcanwm profile image
Medea •

This is really nice! Bookmarked!

Collapse
 
youneslaaroussi profile image
Younes Laaroussi •

I'm glad you found it useful! 🤗

Collapse
 
noviicee profile image
Anamika •

Awesome! 👏 🎉

Collapse
 
youneslaaroussi profile image
Younes Laaroussi •

Thanks a lot! 🤗️

Collapse
 
itshi32 profile image
itshi •

preposterous project? 😳

Collapse
 
youneslaaroussi profile image
Younes Laaroussi •

Fixed! Thanks for pointing it out! 👍️

Collapse
 
jainsakshi profile image
Sakshi J •

A big thanks to you!

Collapse
 
youneslaaroussi profile image
Younes Laaroussi •

And a massive thanks to YOU! 🤗️

Collapse
 
timhuang profile image
Timothy Huang •

Very useful post! Thanks for your sharing.

Collapse
 
youneslaaroussi profile image
Younes Laaroussi •

Thanks for reading! ❤️

Collapse
 
adriens profile image
adriens •

💡 Adding VHS to "Step 5. Record Visuals To Attract Users 👀 " mays also be a very nice option.

Collapse
 
polterguy profile image
Thomas Hansen •

Najs one!! :)

Collapse
 
fabiosouzadev profile image
Fábio Souza •

Awesome!!!!!

Collapse
 
youneslaaroussi profile image
Younes Laaroussi •

YOU'RE AWESOME! 🤗

Collapse
 
beelen74584087 profile image
beelen •

Fascinating innovative publication Shared information is of great motivation that I helped get understanding expertise greetings you have my support and I hope the following publications.

Collapse
 
princesp profile image
PrinceSP •

Grwat explanation. Thank you very much.

Collapse
 
youneslaaroussi profile image
Younes Laaroussi •

I'm glad you found it useful! 👍️

Collapse
 
bennycode profile image
Benny Code •

I have a great example for number 8 (Roadmap). The TypeScript team is publishing its roadmap publicly on GitHub: github.com/microsoft/TypeScript/wi...

Collapse
 
youneslaaroussi profile image
Younes Laaroussi •

This is really useful, thanks! 👍

Collapse
 
tylim88 profile image
Acid Coder • • Edited

just want to show off my badges

FirelordJS

github.com/tylim88/FirelordJS

Collapse
 
youneslaaroussi profile image
Younes Laaroussi •

It looks very good! 👍

Collapse
 
l4rnaud profile image
l4rnaud •

Thanks for this sharing !! Do you recommand some tools for the Step 5. "record visuals" part

Collapse
 
youneslaaroussi profile image
Younes Laaroussi •

I updated the article to include some tools. You can use asciicinema to record your CLI application, or loom to record generally any area in your screen.

Collapse
 
notchoaveragejoe profile image
Hope Kuypers •

This is amazing, thank you for this

Collapse
 
youneslaaroussi profile image
Younes Laaroussi •

I'm glad you liked it! 🤗

Collapse
 
jacksun profile image
Automatic Subtitle Generator Online - Easyssub.com •

Thank you for your article and the tools you shared.
I recently discovered a free auto subtitle generator
easyssub.com/tools/auto-subtitle-g...
, EasySub transcribed subtitles with an accuracy rate of over 95%. It also supports free multi-language subtitle translation. It can also edit videos, add watermarks, titles, and so on. In short, it feels too practical, so share it with everyone, hoping to help everyone.

Collapse
 
mololoco profile image
Marco Antonio •

test

Collapse
 
miketysonofthecloud profile image
Mike Tyson of the Cloud • • Edited

Use Brainboard.co and deploy in-app ;) Take GitHub to the next level! brainboard.co/

Collapse
 
jcubic profile image
Jakub T. Jankiewicz • • Edited
Collapse
 
dickyhermawan12 profile image
Dicky Rahma Hermawan •

It's truly helpful!