Guia de Contribuição
Este projeto é mais do que um projeto pessoal. É um recurso da comunidade, feito para a comunidade. E você pode fazer parte disso.
Este é um projeto open-source
O Ultimate Rust está disponível publicamente no GitHub, e isso significa que ele pode evoluir com a ajuda de pessoas como você. Não importa se você encontrou um erro de digitação, tem uma sugestão de melhoria, quer propor um exemplo mais claro ou deseja adicionar um exercício novo. Toda contribuição é bem-vinda.
Preciso ser sincero com você: este é meu primeiro livro. Isso significa que, por mais cuidado que eu tenha tomado ao escrevê-lo, é inevitável que existam erros de escrita, explicações que poderiam ser mais claras ou até mesmo conceitos que merecem ser expandidos. E está tudo bem. Faz parte do processo.
É exatamente por isso que escolhi tornar este livro open-source. Para que ele não fique estagnado, mas continue melhorando com o tempo, com a ajuda de leitores que se importam.
Formas de Contribuir
Você pode contribuir de várias maneiras, e todas elas são igualmente valiosas:
Corrigindo erros de escrita ou gramática. Se você encontrar um erro de digitação, uma concordância errada ou qualquer problema gramatical, por favor, abra uma issue ou envie um pull request corrigindo. Não tenha receio de apontar erros pequenos. Eles importam.
Sugerindo melhorias nas explicações. Se algum conceito não ficou claro para você, é bem provável que não tenha ficado claro para outras pessoas também. Abra uma issue explicando o que te confundiu e, se tiver uma sugestão de como melhorar, compartilhe. Isso ajuda o livro a se tornar mais didático.
Propondo novos exemplos ou exercícios. Se você criou um exemplo que ilustra bem um conceito, ou se tem uma ideia de exercício que ajudaria os leitores a praticarem, compartilhe. Quanto mais variados forem os exemplos, melhor será a compreensão.
Reportando problemas técnicos. Se algum código do livro não funciona, se há algo desatualizado em relação à versão mais recente do Rust, ou se você encontrou algum problema de compatibilidade, por favor, reporte. Isso garante que o livro continue preciso e atualizado.
Adicionando conteúdo novo. Se você sente que falta algum tópico, ou que algum capítulo poderia se beneficiar de uma seção adicional, você pode propor a adição. Discutiremos juntos como integrar isso da melhor forma.
Como Fazer Sua Contribuição
O processo é simples e segue o padrão de contribuição open-source no GitHub. Você encontrará o repositório do livro em github.com/ultimate-rust/content.
A regra é clara e descomplicada: se você encontrou algo que precisa ser corrigido ou melhorado, você tem duas opções.
Se você identificou o problema mas não sabe como corrigir, ou simplesmente prefere que outra pessoa implemente a solução, abra uma issue descrevendo o que encontrou. Seja específico sobre em qual página ou seção está o problema, o que está errado e, se tiver alguma ideia de como poderia ser melhor, compartilhe também. Eu ou algum outro contribuidor veremos e resolveremos futuramente.
Se você identificou o problema e sabe como corrigir, ou se tem uma proposta de melhoria e quer implementá-la você mesmo, faça um fork do repositório, crie um branch para suas mudanças, faça as alterações necessárias e abra um pull request. No pull request, explique o que você mudou e por quê. Revisarei sua contribuição com atenção e, se tudo estiver alinhado com a proposta do livro, será integrada.
Não existe contribuição pequena demais. Um erro de digitação corrigido é tão valioso quanto um capítulo inteiro revisado. O que importa é que você se importe o suficiente para querer tornar este livro melhor.
Reconhecimento aos Contribuidores
Toda contribuição aceita será reconhecida. Ao abrir um pull request, você pode adicionar seu nome ou nickname na lista de contribuidores que fica ao final do livro. É uma forma pequena, mas sincera, de agradecer por fazer este projeto melhor.
Um Convite
Este livro só melhora se você se envolver. Então, enquanto você lê, mantenha um olhar atento. Se algo não fizer sentido, se algo puder ser melhor, ou se você simplesmente encontrar um errinho bobo, não guarde para si. Abra uma issue. Mande um pull request. Faça parte da construção deste livro.
Juntos, podemos criar o melhor recurso de Rust que já existiu.
Obrigado por estar aqui. Obrigado por contribuir.