bboyer
291

Take Your Github Repository To The Next Level ๐Ÿš€๏ธ

The secret sauce to creating a growing and preposterous project is a great README documentation. It invites new contributors and makes developers 55% more productive.

Octoverse

โ€” Source: Github Octoverse

In this article, I will share with you the secrets to creating a README that stands out. Letโ€™s begin!

Step 1. Come Up With A Name That Sticks ๐Ÿ–Š๏ธ

Clairvoyant

Choosing a name is always a challenge, but you know how crucial it is. Your label will dictate your usersโ€™ first impression and set you apart from the competition.

Find more information in the tweet below ๐Ÿ‘‡๏ธ

unknown tweet media content

Eluda profile image

Eluda

@eludadev

twitter logo

#web3 #NFTGiveaways #startup #100DaysOfCode
Here's a guide on how to name your SaaS startup or your open-source Github project:

16:50 PM - 04 Apr 2022

Twitter reply actionTwitter retweet action Twitter like action

Step 2. Create An Attractive Cover Image :sparkl es:

Cover

The first thing that a person will see when they open your repository is the cover image. This is your chance to grab that personโ€™s attention, and to get them to be interested in your product!

Here are some tools to help you achieve this step ๐Ÿ‘‡๏ธ

unknown tweet media content

Eluda profile image

Eluda

@eludadev

twitter logo

๐Ÿ”ฅ Developers can design too! Here are some tools to help you do that:
#css #javascript #100daysofcode

16:54 PM - 04 Apr 2022

Twitter reply actionTwitter retweet action Twitter like action

Step 3. Write A Compelling Description ๐Ÿ“„

Size Limitโ€™s Description

This is arguably the most essential section in your project. This is where you show people what your project is about, and why they should use it.

Step 4. Add Badges ๐Ÿ”ฅ

Badges

Did you notice those small image links on popular Github projects? They are called badges, and they convey metadata about the project, such as if all tests are passing or not.

Use Shields to add some to your project. I can assure you that it will increase the reputation of your Github repository!

Step 5. Record Visuals ๐Ÿ‘€

GIF

Visuals

It is a very good idea to add screenshots or videos for a more sophisticated README. It wiVll make your users' experiences much smoother, because they can visually see how they should use your product!

Here are some tools that will help you do this ๐Ÿ‘‡๏ธ

unknown tweet media content

Eluda profile image

Eluda

@eludadev

twitter logo

๐Ÿ’กDo you need to record your SaaS application or your CLI application? Here are some tools top help!

16:58 PM - 04 Apr 2022

Twitter reply actionTwitter retweet action Twitter like action

Step 6. Precise Installation Steps โœ…

Setup

You should take your user through the exact steps that they need to take to install your product. This information should also be available for the most common operating systems (Linux, macOS, Windows).

Step 7. Add A Usage Guide ๐Ÿ

Usage

Always use examples of how your product should be used, and show the expected output if you can.

Twitter Follow

Step 8. Create A Supportive Community ๐Ÿค—

Support

People will eventually need help. You should show them where they can go for that, whether it's an issue tracker, a chat room (Discord or Gitter), or simply an email address.

Step 9. Plan A Future Roadmap ๐Ÿš—

Roadmap

This is where you should place your plans for the future. You should be realistic, and explain why you're taking the steps that you are taking.

Step 10. Create Releases ๐Ÿ””

Github Releases

You should use Github Releases to manage the different versions and releases of your product.

Step 11. Write Changelogs ๐Ÿ“–

Changelogs

If you used Github Releases, you should also consider writing the proper changelogs that describe whatโ€™s new in each release. This will make your repository much more attractive!

Twitter Follow

Step 12. Use Github Pages ๐Ÿš€

Pages

After doing all of the above, your repository is already better than 90% of projects on Github. But can you go even further?

Yes! The solution is using Github Pages to take your repository to its own website! You can host any website, like your API documentation, for free on Github! You also get a free domain name like the following: https://<user>.github.io/<repository>.

Learn more here ๐Ÿ‘‡๏ธ

unknown tweet media content

Eluda profile image

Eluda

@eludadev

twitter logo

๐Ÿ’กDo you need to host your website, but don't want to spend any money? Here are some services that let you do that:
#webdev #web3

17:02 PM - 04 Apr 2022

Twitter reply actionTwitter retweet action Twitter like action

Step 13. Create A Special Social Media Preview ๐Ÿ˜

When your Github repository will be posted on social media platforms like Discord or Twitter, an image is also added on top of that link.

Hereโ€™s what you get by default:

Default

But you can customize it, and make it look like this:

Customized

Step 14. Create Contribution Guidelines

Guidelines

There is no open-source without contribution. You will want people to contribute their skills and ideas into your repository.

But to be more professional and organized, most repositories have contribution guidelines in a file named CONTRIBUTING.md.

You can use a template, like the Github Docs Contribution Guidelines.


Credits: โค๏ธ

Those were 11 tips pointing you towards building a better Github project. You should also be asking yourself questions about your repository, like: "What is it", "Why should I make it", etc... If you can answer them, then I can assure you that you're on the right path!

If you found this guide useful, itโ€™d be really helpful if you followed me on Twitter for daily webdev updates! ๐Ÿค—

ๅŽŸๆ–‡้“พๆŽฅ๏ผš

https://dev.to/eludadev/take-your-github-repository-to-the-next-level-17ge

github
ๅ‘ๅธƒไบŽ: 2022ๅนด4ๆœˆ5ๆ—ฅ