// bad
const fruit = ['apple', 'banana', 'cucumber']
// okay
const fruitArr = ['apple', 'banana', 'cucumber']
// good
Good commit messages serve at least three important purposes:
- To speed up the reviewing process.
- To find out what changed in a range of commits (e.g. for a release note).
- To help the future maintainers, say five years into the future, to find out why a particular change was made to the code or why a specific feature was added.
Structure your commit message like this:
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
#include <iostream> | |
#include <cstdlib> | |
class Node | |
{ | |
public: | |
Node* next; | |
int data; | |
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |