Concordo do POR QUE e nesses casos é realmente muito bom, alguns exemplos do código fonte do TabNews, onde numa migration sobre a criação da tabela users
eu anotei o POR QUE de certos valores:
// Why 254 in length? https://stackoverflow.com/a/1199238
email: {
type: 'varchar(254)',
notNull: true,
unique: true,
},
// Why 60 varchar? https://forums.phpfreaks.com/topic/293405-recommended-sql-datatype-for-bcrypt-hash/#comment-1500831
password: {
type: 'varchar(60)',
notNull: true,
},
...
// Why "with timezone"? https://stackoverflow.com/a/20713587
created_at: {
type: 'timestamp with time zone',
notNull: true,
default: pgm.func("(now() at time zone 'utc')"),
},
E pensando agora, o ideal seria apontar para uma issue permanente dentro do projeto com trechos do artigo original (mas ainda linkando para ele), para caso o link se tornar indisponível, você ainda ter a fração que importa sob seu controle.