tamasma tamasma

Tips for a #WINNING Github Profile

The basics

As a new developer some potential employers are going to review your Github profile as part of the interview process. This doc covers some tips that should help you make a good impression. What this doc won't do is polish a turd.

README

Think of your experiences reviewing a Gem or other JS library on Github. Where do you look first? The README of course. What makes for a frustrating repo? One that doesn't:

include a README.
include install instructions (if applicable)

Improve your Github Profile Checklist

Getting Started Tutorials

General

I include at least three projects on my GitHub account.
My GitHub account shows knowledge about how to make incremental commits

Project Title

One Paragraph of project description goes here

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

	import React from 'react';
	import Tabs from '@material-ui/core/Tabs'
	import Tab from '@material-ui/core/Tab'
	import Typography from '@material-ui/core/Typography'
	import { withStyles } from '@material-ui/core/withStyles';


	class ProfileTabs extends React.PureComponent {
	state = { activeIndex: 0 }

	#!/usr/bin/env bash
	set -e

	function usage() {
	set -e
	cat <<EOM
	##### ecs-run #####
	Simple script for running tasks on Amazon Elastic Container Service
	One of the following is required:
	Required arguments:

	# Use envFrom to load Secrets and ConfigMaps into environment variables

	apiVersion: apps/v1beta2
	kind: Deployment
	metadata:
	name: mans-not-hot
	labels:
	app: mans-not-hot
	spec:
	replicas: 1

	import boto3
	import logging

	#setup simple logging for INFO
	logger = logging.getLogger()
	logger.setLevel(logging.INFO)

	#define the connection
	ec2 = boto3.resource('ec2')