This guide is meant to help you present yourself on GitHub. This will help you in making a good impression on potential clients, future employers etc.
Join the 13|37 organization on GitHub - https://github.com/tretton37/. You can do this by opening a ticket at https://service.tretton37.com. Make sure to write your GitHub username in the ticket.
For your profile to be shown publicly as part of 13|37 you need to do the following steps:
-
Go to the organization page - https://github.com/tretton37/.
-
Click on people.
-
Find yourself on the list.
-
Change the organization visibility from private to public.
You should fill out your GitHub profile info. You can access it via https://github.com/ + <your GitHub username> by clicking on "Edit Profile" under your profile picture. Fill in all the infomation you want to make public.
You should feature the repositories that you are proud of on your profile. You do this by going to your profile and "pining" those projects. To access the pinning feature click "Customize your pins" on the top right of your project list.
You should always include a README.md file in your project, which explains what the project is and how to use it.
You can actually do a lot with the front page of your github profile (see two examples below). You do this by adding a README.md file to your profile page. Follow these steps to do so:
You will need to create a new public repository with the same name as your GitHub username like so:
Remember to tick the "Add a README file" checkbox and click "Create repository".
To edit your readme file simply go to the repository you just created, find the README.md file and click the edit icon on the top right, like so:
The OSS team has created a readme generator to help you make a 13|37 branded readme. With a few clicks you can create an awesome profile as Denis has:
To use the generator, enter the information in various forms. After you are done copy the generated mardkown text (bottom right) to your README.md file.
If you want your profile to be more personalized you can create it manually and still achieve good results like Luka did here:
The README file is written in a markup language called markdown. If you're not familiar with it and have plenty of time, here is the getting started guide and if you are lacking time here is a cheat sheet.
Now you can more effectively express yourself by using links, images, badges, emojis and even HTML.
You can also add various cool widgets to your GitHub readme like the github-readme-stats.
Here is Luka's README.md:
You can look at an example of everything mentioned on Luka's repository (click on raw view to look at the code).
GitHub Pages is a tool that enables you to easily showcase your profile, project or organisation as a static webpage. GitHub will host your webpage for free.
So here is how to do it:
You will need to create a new public repository with the name GitHubUsername.github.io. Like so:
To add an index.html to your repository you will need to clone your repo and push the changes. See other guides if you are unsure how to do this.
I've added a simple index file with my favourite code editor Visual Studio Code:
Now push this file to your repository.
You can find your website at GitHubUsername.github.io . Here is what mine looks like on my favourite browser:
First, add the index.html file to somewhere in your repository. It is recommended to make a new branch specifically for this purpose. Now go to your repository and click settings. In the Pages tab you need to point to that index page in its respective branch:
And that's it!