Here are some of the tricks to create an impressive GitHub repository
We all have seen the same old repository as every other repository looks the same and feels the same. If you want to attract some attention then here are some simple tricks
- ๐จ๐๐ฒ ๐๐ฒ๐๐ฐ๐ฟ๐ถ๐ฝ๐๐ถ๐๐ฒ ๐๐ผ๐บ๐บ๐ถ๐ ๐ ๐ฒ๐๐๐ฎ๐ด๐ฒ๐ 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:
[optional scope]:
๐๐ฑ๐ฑ ๐๐บ๐ผ๐ท๐ถ ๐ฎ๐ป๐ฑ ๐๐๐๐ ๐ถ๐ป ๐๐ต๐ฒ ๐ฅ๐ฒ๐ฎ๐ฑ๐ ๐ฒ ๐ณ๐ถ๐น๐ฒ The ReadME file is the first thing that a user sees. 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.
Use backticks to highlight the code snippets
- Add some hyperlinks
- Add emojis if required
Add stat figures like no. of stars, commits, PRs etc.
๐๐ฑ๐ฑ ๐๐ถ๐ฐ๐ฒ๐ป๐๐ฒ 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.
๐๐ฑ๐ฑ ๐ง๐ฎ๐ด๐ ๐ฎ๐ป๐ฑ ๐ผ๐ป๐ฒ ๐น๐ถ๐ป๐ธ 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!
๐๐ฑ๐ฑ ๐๐ฒ๐๐ฐ๐ฟ๐ถ๐ฝ๐๐ถ๐ผ๐ป (๐๐ถ๐๐ต ๐๐บ๐ผ๐ท๐ถ๐ & ๐๐ถ๐ป๐ธ) 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 ๐.
These are some of the most common tricks for the GitHub repository. That's all for today guys, follow for more tips and tricks :)
#github #project #coding #webdevelopment