Cuneyt Ozen littlebeeper

Code is clean if it can be understood easily – by everyone on the team. Clean code can be read and enhanced by a developer other than its original author. With understandability comes readability, changeability, extensibility and maintainability.

General rules

Follow standard conventions.
Keep it simple stupid. Simpler is always better. Reduce complexity as much as possible.
Boy scout rule. Leave the campground cleaner than you found it.
Always find root cause. Always look for the root cause of a problem.

Design rules

How to Keep Pull Requests Manageable

There are a lot different things you can try to keep pull requests manageable.
These pointers are not meant to be rules, but merely guidelines when possible. Due to the nature of what you are working on, some of these techniques may not be possible (or incredibly difficult).

Either way, here are some tips to help make people not want to claw their eyes out reviewing a pull request.

The Basics

These are the fundamental basics to a pull request and ALL pull requests should have these, regardless of how small or meaningless it is.

Debugging a Docker image

Start up the Docker container from image:

docker run --entrypoint "/bin/sh" --rm imagename:latest -c "sleep 24h"

Obtain the container hash id:

docker ps

	import java.security.InvalidKeyException;
	import java.security.NoSuchAlgorithmException;
	import java.security.SignatureException;
	import java.util.Formatter;

	import javax.crypto.Mac;
	import javax.crypto.spec.SecretKeySpec;


	/**

	Latency Comparison Numbers (~2012)
	----------------------------------
	L1 cache reference 0.5 ns
	Branch mispredict 5 ns
	L2 cache reference 7 ns 14x L1 cache
	Mutex lock/unlock 25 ns
	Main memory reference 100 ns 20x L2 cache, 200x L1 cache
	Compress 1K bytes with Zippy 3,000 ns 3 us
	Send 1K bytes over 1 Gbps network 10,000 ns 10 us
	Read 4K randomly from SSD* 150,000 ns 150 us ~1GB/sec SSD

	#!/bin/bash
	# A simple script to backup an organization's GitHub repositories.

	#-------------------------------------------------------------------------------
	# NOTES:
	#-------------------------------------------------------------------------------
	# * User @jimklimov (and probably some others called out in the long comment
	# thread below) have modified this script to make it more robust and keep
	# up with various changes in the GitHub API and response format at:
	# https://github.com/jimklimov/github-scripts

	#!/bin/sh
	echo Install all AppStore Apps at first!
	# no solution to automate AppStore installs
	read -p "Press any key to continue... " -n1 -s
	echo '\n'

	echo Install and Set San Francisco as System Font
	ruby -e "$(curl -fsSL https://raw.github.com/wellsriley/YosemiteSanFranciscoFont/master/install)"
	echo Install Homebrew, Postgres, wget and cask
	ruby -e "$(curl -fsSL https://raw.github.com/Homebrew/homebrew/go/install)"

	###############################################################################
	# Version 1: using ‘apt-get install’
	# Installs using apt-get
	# Requires update to npm afterwards
	# Harder to get latest copy of node
	# Requires sudo to use npm
	###############################################################################

	# create new docker ubuntu container
	sudo docker run -i -t ubuntu /bin/bash # drops you into container as root

	#!/bin/sh

	# recursively removes all .pyc files and __pycache__ directories in the current
	# directory

	find . \| grep -E "(__pycache__\|\.pyc$)" \| xargs rm -rf

	/**
	* This will mask a portion of a credit card with 'x' if it finds it in a sentence.
	\b(?:

	# Visa card number 4[\ -](?:\d[\ -]){11}(?:(?:\d[\ -]*){3})?\d\|

	# MasterCard card number (?:5[\ -][1-5](?:[\ -]\d){2}\|(?:2[\
	-]){3}[1-9]\|(?:2[\ -]){2}[3-9][\ -]\d\|2[\ -] [3-6](?:[\ -]*\d){2}\|2[\
	-]7[\ -][01][\ -]\d\|2[\ -]7[\ -]2[\ -]0)(?:[\ -]*\d){12}\|