Want to hook users up to your GitHub repository? Want GitHub to promote your repository? Want users to come back to your repository again, and again?
If you answered YES to all the questions, you have come to the right place, my disciple. In this article, we will be going over how to create an impressive GitHub repository that hooks users!
1. Add Description (with Emojis & Link)
This is the lowest hanging fruit in creating an impressive GitHub repository. You can just add a short description of the repository to heighten its appeal. Make sure to throw in some emojis too 😉.
You also get extra brownie points 🎂 for adding relevant links too!
You can update the description and the link from the top right settings icon
2. Add Tags
Adding tags is the next and most crucial step in this article. It not only makes it easier for GitHub to promote the repository but also makes it look much more professional!
Tag related settings are also available in the repository configuration shown in the previous step
3. Add License
No point denying it, this is the most boring step, but essential for fair use of the repository. Moreover, it also shows up in the info tab, so just get it done with.
To add a License, create a file called LICENSE at the root of the project.
4. Add Readme
The ReadMe is the first thing a visitor sees when they visit the repository, so taking some time to create a polished repository is crucial. It should describe what problem the code solves, how to set it up, and any other relevant information.
There is always some way to make the ReadMe engaging. Even if you don't have much to write about the repository itself. Take the example of a repository containing coding problem solutions. You can easily list out the problems in the ReadMe and link to the solutions.
To add a ReadMe, create a ReadMe.md file at the root of the project.
5. Use Descriptive Commit Messages
Using descriptive commit messages might look like a chore, but it too helps in taking the appeal of the repository higher. Make sure the commit message is explanatory.
There are various schools of commit message structures, any of which is acceptable. I personally like the following one:
<type>[optional scope]: <description>
If you want to dive deeper into how it is structured, check out this article
6. BONUS: Use Multiple Languages
Using multiple languages in your repository is a great way to grab the user's attention, but this is highly context-dependent. You should NOT use multiple languages only to increase the appeal, but only if it is required.
Even if you falter in this department, as long as you implement the other tricks, you are completely covered!
Repositories used
ruppysuppy
/
Daily-Coding-Problem-Solutions
🎓🖥️ Solutions for 350+ Interview Questions asked at FANG and other top tech companies
ruppysuppy
/
Crypto-Crowdfund
🤑💰 Crowdfunding Platform backed by Ethereum Blockchain to bring your creative projects to life
ruppysuppy
/
SmartsApp
💬📱 An End to End Encrypted Cross Platform messenger app.
mui
/
material-ui
Material UI: Comprehensive React component library that implements Google's Material Design. Free forever.
Finding personal finance too intimidating? Checkout my Instagram to become a Dollar Ninja
Thanks for reading
Need a Top Rated Front-End Development Freelancer to chop away your development woes? Contact me on Upwork
Want to see what I am working on? Check out my Personal Website and GitHub
Want to connect? Reach out to me on LinkedIn
I am a freelancer who will start off as a Digital Nomad in mid-2022. Want to catch the journey? Follow me on Instagram
Follow my blogs for Weekly new Tidbits on Dev
FAQ
These are a few commonly asked questions I get. So, I hope this FAQ section solves your issues.
-
I am a beginner, how should I learn Front-End Web Dev?
Look into the following articles:
Top comments (0)