- What Makes a Good Github Profile?
- Yasmine Hejazi
- The Nuggets translation Project
- Permanent link to this article: github.com/xitu/gold-m…
- Translator: caiyundong
- Proofread: Zenblo, Chorer, Hoarfroster, Lsvih
How to create a good GitHub user profile?
I definitely underestimated GitHub when I was applying for an internship in college. I wrote many projects in college, and I wrote detailed description documents for each project, which can be easily translated into project README files. But I didn’t take the time to upload and maintain these projects on GitHub, and I soon realized I’d missed the boat.
In fact, maintaining GitHub user profiles takes a lot of time and effort. Being able to document and keep the previous code up to date as you move on to your next project in the course is tedious work. However, with a little more effort, a class project or other project can turn into a meaningful portfolio, and a portfolio is an excellent way to stand out from the crowd.
Which job seekers have benefited the most from GitHub projects?
Entry-level job seekers (college students, recent graduates, and boot camp trainees) benefit from this because they lack technical expertise and have worked on projects where they can best demonstrate their skills. Experienced developers looking to transform can also benefit greatly from the GitHub project. A programmer who is not willing to be challenged or forced to program in an unpopular language will have a hard time finding an employer with the latest technology stack without experience.
In this article, I’ve put together a list of things I learned from my college and mentors to show you how to create a GitHub profile to aid your job application. I’m by no means a GitHub power user, but read on for these helpful guidelines I’d like you to follow.
Add a detailed description document to each project repository
Documenting your own code has a long way to go — not just for any users who plan to use these tools, but also for recruiters and hiring managers who look at your profile. Adding well-formed documents to the repository shows that:
- You have good communication skills.
- You know how to invest in a project for the long term.
In the documentation, you should specify the purpose of the project and use cases, and of course installation instructions so that users can easily run or use whatever tools or products you create. Last but not least, you should add a demo (screenshots or GIF files are a plus!). Or a demo link so that users can easily experience your work.
Write clean and organized code
Being able to produce clean code is a must when you’re working with a team. One of the most frustrating things for hiring managers or team members is that when they see the code, it’s hard to deal with. Just like the instructions, showing good organization in your code is a great way to impress without disappointing people. It’s good practice to create functions for repetitive code and standardize your code.
Include comments in your code as needed or as best practices in your programming language. For example, in Python, you can add Docstrings to your functions. Consider keeping your notes concise so they don’t annoy people. To reduce redundant comments, make sure you choose variable names that make sense and keep your code as simple as possible (try to avoid writing hack code). Your comments should reflect the intent of the code more.
In general, you should have a good project and file structure. For example, if you have many helper functions, keep them in a separate file. Also, write test cases for your code if you can.
Stay active
Goal: You definitely want to get those green blocks! More green signals that you are active on the platform and are contributing code, which is a good sign for hiring managers.
General rule of thumb: Update and submit your code frequently. Are you working on a school project? Update your GitHub as you progress. It’s fine to keep projects small, but try to diversify them to showcase your different skills.
Keep your projects up to date. As you learn, you may make changes or updates to previous projects.
In addition to submitting changes to the repository, you can keep active with other contributions, such as:
- Post a question
- Make a project merge request
- Submit a project consolidation request for review
Do you use GitHub in your workplace? You can showcase your contributions in the private Library by turning on the “Enable Private Contributions” switch in the Work Activities section under your user profile in order to showcase your work activities under your user profile.
Use of making Pages
GitHub Pages is a great tool for hosting web Pages directly from your repository. The power is that users can see the results of your project in real time. For example, if your project is a website, GitHub Pages can host index.html with a few simple clicks. In addition, any changes you push will be reflected directly on the hosted page without deployment. Creating a demo or hosting page for your project is key to showcasing your skills. If you’re not sure how to host a presentation page, GitHub Pages is a good choice.
Manage your location and user profile information
To connect you to your profile, you should include your professional information and contact information. Recruiters use search tools to look up profiles based on location, so including location information in your profile will make it easier for them to find you. If you have GitHub followers, these links can also make it easier for them to find you on other platforms.
You can also customize your GitHub page by topping out certain warehouses. Choose the best projects that you want your users to see first.
Remember that GitHub is not your resume. For recruiters and hiring managers, high-quality GitHub profiles and projects are just supplementary material to your interview application and interview content. Don’t make it the center of everything — keep your description brief and even show a little personality.
Other Tips
- Take advantage of the ability to add descriptions and labels to your warehouse to keep the information accurate and informative.
- Keep the updates you submit professional and informative. Include things like “Fix bugs” or “Why isn’t this working??” More meaningful content.
- If you want people to contribute to your project, have clear guidelines for contribution. t
- Remove unnecessary information, such as a repository branch that you no longer use.
- Get involved in the community – contribute to open source projects!
conclusion
With these guidelines in mind, I revamped my GitHub profile to make it a useful tool for applying for jobs. I even mentioned projects I worked on in conversations with interviewers. I highly recommend using GitHub as an important tool in your job search and in building a good, professional online presence. Good luck!
If you find any mistakes in your translation or other areas that need to be improved, you are welcome to the Nuggets Translation Program to revise and PR your translation, and you can also get the corresponding reward points. The permanent link to this article at the beginning of this article is the MarkDown link to this article on GitHub.
The Nuggets Translation Project is a community that translates quality Internet technical articles from English sharing articles on nuggets. The content covers Android, iOS, front-end, back-end, blockchain, products, design, artificial intelligence and other fields. If you want to see more high-quality translation, please continue to pay attention to the Translation plan of Digging Gold, the official Weibo, Zhihu column.