英語のドキュメントを翻訳していると、翻訳が古くなることがある。本家ドキュメントが GitHub で管理されていれば、本家が更新されて翻訳が古くなったときに、差分だけを翻訳し直して最新に追従するといったことができる。そうするためには、翻訳ドキュメントの中に本家ドキュメントのコミットハッシュ値を書き残しておけばよい。本家が更新されたら、最新のコミットと、翻訳が参照しているコミットを見比べる。
このやり方を応用して、翻訳ドキュメントが本家の最新コミットに追従しているかどうかをひと目でわかるようにしたのが、このバッジである。
バッジには本家ドキュメントのコミットハッシュ値が含まれていて、その値が本家の最新のコミットハッシュ値を一致していれば up to date
と表示され、一致していなければ out of date
と表示される。