shane shanezhiu

Go Code Review Comments

This page collects common comments made during reviews of Go code, so that a single detailed explanation can be referred to by shorthands. This is a laundry list of common mistakes, not a style guide.

You can view this as a supplement to http://golang.org/doc/effective_go.html.

Please discuss changes before editing this page, even minor ones. Many people have opinions and this is not the place for edit wars.

To remove a submodule you need to:

Delete the relevant section from the .gitmodules file.
Stage the .gitmodules changes git add .gitmodules
Delete the relevant section from .git/config.
Run git rm --cached path_to_submodule (no trailing slash).
Run rm -rf .git/modules/path_to_submodule (no trailing slash).
Commit git commit -m "Removed submodule "
Delete the now untracked submodule files rm -rf path_to_submodule

Spurred by recent events (https://news.ycombinator.com/item?id=8244700), this is a quick set of jotted-down thoughts about the state of "Semantic" Versioning, and why we should be fighting the good fight against it.

For a long time in the history of software, version numbers indicated the relative progress and change in a given piece of software. A major release (1.x.x) was major, a minor release (x.1.x) was minor, and a patch release was just a small patch. You could evaluate a given piece of software by name + version, and get a feeling for how far away version 2.0.1 was from version 2.8.0.

But Semantic Versioning (henceforth, SemVer), as specified at http://semver.org/, changes this to prioritize a mechanistic understanding of a codebase over a human one. Any "breaking" change to the software must be accompanied with a new major version number. It's alright for robots, but bad for us.

SemVer tries to compress a huge amount of information — the nature of the change, the percentage of users that wil

some tools for diagrams in software documentation

Diagrams For Documentation

Obvious Choices

ASCII

Commit Message Conventions

These rules are adopted from the AngularJS commit conventions.

Goals
Generating CHANGELOG.md
- Recognizing unimportant commits
- Provide more information when browsing the history
Format of the commit message
Subject line

	// 检测浏览器的 User Agent 应该是非常简单的事情
	// 微信在 Android 下的 User Agent
	mozilla/5.0 (linux; u; android 4.1.2; zh-cn; mi-one plus build/jzo54k) applewebkit/534.30 (khtml, like gecko) version/4.0 mobile safari/534.30 micromessenger/5.0.1.352

	// 微信在 iPhone 下的 User Agent
	mozilla/5.0 (iphone; cpu iphone os 5_1_1 like mac os x) applewebkit/534.46 (khtml, like gecko) mobile/9b206 micromessenger/5.0

	// 通过javascript判断
	// 很容易看出来，微信的 User Agent 都有‘micromessenger’字符串标示，我们判断是否含有这些字符串就OK了
	function isWeixinBrowser(){

	// List of language tags according to RFC 5646.
	// See <http://tools.ietf.org/html/rfc5646> for info on how to parse
	// these language tags. Some duplicates have been removed.
	var RFC5646_LANGUAGE_TAGS = {
	'af': 'Afrikaans',
	'af-ZA': 'Afrikaans (South Africa)',
	'ar': 'Arabic',
	'ar-AE': 'Arabic (U.A.E.)',
	'ar-BH': 'Arabic (Bahrain)',
	'ar-DZ': 'Arabic (Algeria)',

	# Hello, and welcome to makefile basics.
	#
	# You will learn why `make` is so great, and why, despite its "weird" syntax,
	# it is actually a highly expressive, efficient, and powerful way to build
	# programs.
	#
	# Once you're done here, go to
	# http://www.gnu.org/software/make/manual/make.html
	# to learn SOOOO much more.

	.PHONY: hook

	CC=gcc -std=c99 -Wall

	hook: hook-main hook-preload.so
	./hook-main
	LD_PRELOAD=./hook-preload.so ./hook-main

	hook-main: hook-main.c
	${CC} -O0 -Wl,--export-dynamic -g -ggdb -o $@ $^ -ldl

	- What do Etcd, Consul, and Zookeeper do?
	- Service Registration:
	- Host, port number, and sometimes authentication credentials, protocols, versions
	numbers, and/or environment details.
	- Service Discovery:
	- Ability for client application to query the central registry to learn of service location.
	- Consistent and durable general-purpose K/V store across distributed system.
	- Some solutions support this better than others.
	- Based on Paxos or some derivative (i.e. Raft) algorithm to quickly converge to a consistent state.
	- Centralized locking can be based on this K/V store.