Como contribuir¶

Blockchain Engineering é um livro técnico de código aberto. Correções e revisões técnicas são bem-vindas.

Contribuições úteis¶

Boas contribuições incluem:

corrigir um erro técnico
esclarecer uma explicação
acrescentar uma fonte primária ausente
corrigir um link quebrado
melhorar um diagrama
melhorar um exemplo de código
identificar uma alegação histórica que precisa ser qualificada
uniformizar a terminologia
melhorar a navegação entre capítulos

Antes de abrir um pull request¶

O livro prioriza fontes primárias, linguagem técnica direta, explicações que começam pelo mecanismo, trade-offs explícitos e uma separação clara entre fato, interpretação e especulação.

Novos capítulos¶

Antes de acrescentar um capítulo, consulte o sumário e o acompanhamento editorial. Todo capítulo novo deve ocupar um lugar claro na estrutura existente.

Economia¶

Não escreva capítulos econômicos como defesa de uma escola.

Apresente os argumentos a partir de textos originais sempre que possível, distinga o que o autor escreveu das interpretações posteriores e inclua argumentos concorrentes quando forem relevantes para o tema.

História¶

Use datas e fontes primárias sempre que possível. Quando a evidência for incerta, diga isso com clareza.

A identidade real de Satoshi Nakamoto continua desconhecida. Não apresente especulação como fato.

Segurança¶

As contribuições sobre segurança devem se concentrar em compreensão, prevenção e mitigação. Não acrescente instruções destinadas a explorar sistemas ativos ou roubar fundos.

Pull requests¶

Mantenha cada pull request focado. Uma correção técnica pequena é mais fácil de revisar do que uma reescrita extensa que mistura capítulos sem relação entre si.