Github Example Readme

admin

Do you know that many recruiters/interviewers care about candidates’ Github profiles?

Can you send a link to an example? That's not a GitHub README, that's a presentation made with reveal.js.

  • For example, i am going to create a readme.md file using the GitHub user interface. After i switch back to the Replit website, Replit will tell me that.
  • Jekyll has a thorough README. The server will set your pages to be hosted at example.com, and create redirects from www.example.com and charlie.github.
  • Now that developers can create a private GitHub repository in its free tier, you may run into issues with the 'fatal: repository not found' error message. Here's how to fix that problem.

A good Github profile can both make you more likely to pass resume screening and impress the interviewer.

However only few candidates have a Github page on their resumes and most of them are not well maintained. So you definitely get better chance to stand out by keeping an up-to-date Github profile.

In this post, I’ll tell you how to build an outstanding Github profile step by step to impress both recruiters and interviewers.

Github

GitHub is a Web-based Git repository hosting service. It offers all of the distributed revision control and source code management (SCM) functionality of Git as well as adding its own features.

Unlike Git, which is strictly a command-line tool, GitHub provides a Web-based graphical interface and desktop as well as mobile integration. It also provides access control and several collaboration features such as bug tracking, feature requests, task management, and wikis for every project.

So people can use Github to store, share and discuss both personal and corporate projects. For a well maintained profile, you can easily tell what projects the owner have worked in the past and you may even check the code.

Why is Github profile important?

For both recruiters and interviewers, it’s very important to know what each candidate has been working on in the past.

However, we all know that resume becomes less and less valuable because people tend to exaggerate their past contributions/skills and it’s extremely hard to verify. Some people may even fake their resumes.

From this perspective, Github profile is much more real.

By looking at one’s Github repositories, you can almost immediately tell if he’s an expert or beginner of a specific field.

Also number of repositories, frequency of contributions activities and maybe number of followers/followings can also reflect how passionate the owner is about programming. AFAIK, most famous programmers are quite active on Github.

As an interviewer/recruiter

When I saw someone with a very outstanding Github page, I would definitely have a great impression about him even before we met.

Github Example Readme.md

As a result, I was kind of convinced that he would pass the interview in my subconscious. Also I would be more likely to discuss with him about things he had worked on in the past and may write them down in the feedback.

However I could hardly get the same level of good impression by a good resume as I saw too many cases where the candidate with a perfect resume failed the simplest question.

So how to build an impressive Github profile?

Personal page on Github

It’s recommended to have your personal website and it’s totally fine if it’s just a single page.

There are many websites providing such kind of service for free like about.me, wordpress. However many people don’t know that you can also use Github to create your personal website.

The official guide from Github teaches you how to set up your site from scratch. If you know some front end development and like to build your landing page by yourself, you can definitely start working from here.

If you want to save your time from coding your personal page, you can follow these two simple guides: Making a personal site, The Absolute Noob Guide To Hosting A Personal Website Or Blog On GitHub Pages.

Here are also quite a few Github page templates.

Maintain your repositories

The rule of thumb is always keeping your Github repositories up to date.

Whenever you are working on something interesting, you can just upload it to Github. Actually you can benefit a lot from this as you can work on your projects anywhere with any computers with internet access. You can also collaborate with others.

If you don’t know what to put on your Github, here are some suggestions:

  • Side projects. This is the number one thing I recommended. Almost all good programmers I know have a lot of side projects. They just like to code and work on things that interest them. That’s also why many companies like to ask your side projects as a way to evaluate.
  • Course projects. If you are students or new grads, you must have done a lot of projects in different courses. You can choose to upload those non-trivial ones. Be careful that don’t upload code for projects that will be reused for following semesters.
  • Open source projects. This is what Github is mostly famous for. There are so many open source projects on Github and most of them are maintained and contributed by passionate programmers. It’s a great chance for you to learn a lot from collaborating with them.
  • Fork/Follow some projects. Sometimes you may just want to learn how it works in a project. You can fork it as your own repository and build your own version.

Also the explore section can also give you some inspiration on what’s trending on Github.

Building a good Github profile takes time as you won’t be able to come up with 10 projects in a day. Starting as early as possible is highly recommended.

Be professional

Many people use Github as a platform to collaborate with others, so it’s very important to keep everything complete and easy to understand.

If you expect to use your Github page to impress others, you’d better pay attention to this point even if you work all your projects by yourself.

1. Write clear description

No one will read your code to understand what you are working on. Keeping your description clear and up to date makes your repositories look professional.

2. Write well formatted README

Each repository in Github can have a README file, which supports markdown format. It’s highly recommended to have README for every repository and if the project is a library, you’d better put detailed instructions in it.

3. Maybe use Issues to track bugs

It’s not necessary but you can use Github Issues to keep track of all the bugs and feature requests.

A great example is Facebook Github page. Every project is well maintained with clear description and detailed instructions.

Keep your code clean

Hd Mkv Player For mac. Even if you are working by yourself, it’s still a good habit to keep your code clean.

Pay attention to your coding style, which is the most obvious way to differentiate yourself from non-professional programmers. You can follow Google style guide for Java, C++and Python, which are very popular.

Don’t leave large block of comment codes and make sure your Master branch is always workable.

Try to make your code of production quality and everything crappy should only exist on your local branches.

Avoid too many forks

It’s really annoying to look at someone’s profile with a bunch of forked repositories.

You should only fork repositories you need and nothing else. Try to clear your repositories in a regular basis. Remember that you can always re-fork back those repositories as long as they are not deleted.

Summary

Both interviewees and interviewers are complaining that 1h is too short to evaluate someone’s ability and skills, and resume is even harder to differentiate people.

Checking people’s past projects solves this problem to some extent.

Github

As I said before, it takes time to build an impressive Github profile and the most important is to start now!

If you like this post, please share us on Facebook 🙂

Double Your Chance of Getting Hired in 45min?

Gainlo (gainlo.co) is a platform that allows you to have mock interview with experienced interviewers from Google, Amazon, Linkedin etc. and get real feedback to improve.

Leave your name and email to learn more about Gainlo below.

The post is written by Gainlo - a platform that allows you to have mock interviews with employees from Google, Amazon etc.
I'd like to learn more

Related posts:

The Hello World project is a time-honored tradition in computer programming. It is a simple exercise that gets you started when learning something new. Let’s get started with GitHub!

You’ll learn how to:

  • Create and use a repository
  • Start and manage a new branch
  • Make changes to a file and push them to GitHub as commits
  • Open and merge a pull request

What is GitHub?

GitHub is a code hosting platform for version control and collaboration. It lets you and others work together on projects from anywhere.

This tutorial teaches you GitHub essentials like repositories, branches, commits, and Pull Requests. You’ll create your own Hello World repository and learn GitHub’s Pull Request workflow, a popular way to create and review code.

No coding necessary

To complete this tutorial, you need a GitHub.com account and Internet access. You don’t need to know how to code, use the command line, or install Git (the version control software GitHub is built on).

Tip: Open this guide in a separate browser window (or tab) so you can see it while you complete the steps in the tutorial.

Step 1. Create a Repository

A repository is usually used to organize a single project. Repositories can contain folders and files, images, videos, spreadsheets, and data sets – anything your project needs. We recommend including a README, or a file with information about your project. GitHub makes it easy to add one at the same time you create your new repository. It also offers other common options such as a license file.

Your hello-world repository can be a place where you store ideas, resources, or even share and discuss things with others.

To create a new repository

  1. In the upper right corner, next to your avatar or identicon, click and then select New repository.
  2. Name your repository hello-world.
  3. Write a short description.
  4. Select Initialize this repository with a README.

Click Create repository.

Step 2. Create a Branch

Branching is the way to work on different versions of a repository at one time.

By default your repository has one branch named main which is considered to be the definitive branch. We use branches to experiment and make edits before committing them to main.

When you create a branch off the main branch, you’re making a copy, or snapshot, of main as it was at that point in time. If someone else made changes to the main branch while you were working on your branch, you could pull in those updates.

This diagram shows:

  • The main branch
  • A new branch called feature (because we’re doing ‘feature work’ on this branch)
  • The journey that feature takes before it’s merged into main

Have you ever saved different versions of a file? Something like:

  • story.txt
  • story-joe-edit.txt
  • story-joe-edit-reviewed.txt

Branches accomplish similar goals in GitHub repositories.

Here at GitHub, our developers, writers, and designers use branches for keeping bug fixes and feature work separate from our main (production) branch. When a change is ready, they merge their branch into main.

To create a new branch

  1. Go to your new repository hello-world.
  2. Click the drop down at the top of the file list that says branch: main.
  3. Type a branch name, readme-edits, into the new branch text box.
  4. Select the blue Create branch box or hit “Enter” on your keyboard.

Now you have two branches, main and readme-edits. They look exactly the same, but not for long! Next we’ll add our changes to the new branch.

Step 3. Make and commit changes

Bravo! Now, you’re on the code view for your readme-edits branch, which is a copy of main. Let’s make some edits.

On GitHub, saved changes are called commits. Each commit has an associated commit message, which is a description explaining why a particular change was made. Commit messages capture the history of your changes, so other contributors can understand what you’ve done and why.

Make and commit changes

  1. Click the README.md file.
  2. Click the pencil icon in the upper right corner of the file view to edit.
  3. In the editor, write a bit about yourself.
  4. Write a commit message that describes your changes.
  5. Click Commit changes button.

These changes will be made to just the README file on your readme-edits branch, so now this branch contains content that’s different from main.

Step 4. Open a Pull Request

Nice edits! Now that you have changes in a branch off of main, you can open a pull request.

Pull Requests are the heart of collaboration on GitHub. When you open a pull request, you’re proposing your changes and requesting that someone review and pull in your contribution and merge them into their branch. Pull requests show diffs, or differences, of the content from both branches. The changes, additions, and subtractions are shown in green and red.

As soon as you make a commit, you can open a pull request and start a discussion, even before the code is finished.

By using GitHub’s @mention system in your pull request message, you can ask for feedback from specific people or teams, whether they’re down the hall or 10 time zones away.

You can even open pull requests in your own repository and merge them yourself. It’s a great way to learn the GitHub flow before working on larger projects.

Open a Pull Request for changes to the README

Click on the image for a larger version

StepScreenshot
Click the Pull Request tab, then from the Pull Request page, click the green New pull request button.
In the Example Comparisons box, select the branch you made, readme-edits, to compare with main (the original).
Look over your changes in the diffs on the Compare page, make sure they’re what you want to submit.
When you’re satisfied that these are the changes you want to submit, click the big green Create Pull Request button.
Give your pull request a title and write a brief description of your changes.

When you’re done with your message, click Create pull request!

Tip: You can use emoji and drag and drop images and gifs onto comments and Pull Requests.

Step 5. Merge your Pull Request

Github Profile Readme

In this final step, it’s time to bring your changes together – merging your readme-edits branch into the main branch.

  1. Click the green Merge pull request button to merge the changes into main.
  2. Click Confirm merge.
  3. Go ahead and delete the branch, since its changes have been incorporated, with the Delete branch button in the purple box.

Celebrate!

File

By completing this tutorial, you’ve learned to create a project and make a pull request on GitHub!

Here’s what you accomplished in this tutorial:

  • Created an open source repository
  • Started and managed a new branch
  • Changed a file and committed those changes to GitHub
  • Opened and merged a Pull Request

Take a look at your GitHub profile and you’ll see your new contribution squares!

To learn more about the power of Pull Requests, we recommend reading the GitHub flow Guide. You might also visit GitHub Explore and get involved in an Open Source project.

Tip: Check out our other Guides, YouTube Channel and On-Demand Training for more on how to get started with GitHub.

Last updated July 24, 2020