You can check this post in english
Ontem eu comecei a ajudar na Linguagem de Programação Crystal, então eu gostaria de compartilhar aqui minhas experiências e que possam servir de referência futuramente.
Como eu conhecia o codetriage.com, comecei olhando algumas issues antigas para contribuir, ou pelo menos verificar se ainda eram aplicáveis com a base de código atual.
Meu primeiro desafio foi colocar o compilador rodando com algumas versões (como Crystal ainda não possui gerenciador de multi-versões, brew fez o trabalho)
Você pode checar como fazer isto no gist.
Depois de instalada a versão mais recente da linguagem Crystal, comecei procurando dentro das issues e encontrei uma mais simples sobre o compilador. Para trabalhar no compilador é necessário testar com a verão master do repositório, então seguem os passos para compilar a mesma:
xcode-select --install
brew install \
bdw-gc \
gmp \
libevent \
libpcl \
libxml2 \
libyaml \
llvm
git clone https://github.com/crystal-lang/crystal.git
cd crystal
make
Realmente fácil, então vamos começar o hacking time!
Primeiro eu escolhi issue #194, não me pergunte o por que pensei que esta poderia ser fácil... hahaha
Então, quando estava procurando por uma solução, encontrei um erro de digitação na documentação e corrigi. Primeiro PR enviado, legal! É um bom caminho para aquecer.
ps: Em sua build o Crystal realiza testes na formatação, incluindo na documentação, então quando enviar um documento PR não use [skip ci]
O fluxo de trabalho para fazer a alteração no compilador é:
make crystal spec é um pouco demorado, então você pode achar mais útil apenas rodar um teste específico (com crystal spec spec/path/to/file_spec.cr), e então quando terminar rodar make crystal spec antes de commitar.
ps: Como eu estava brincando com o compilador, fiz make clean crystal spec antes do PR, apenas para recompilar o mesmo e checar se tudo estava ok, de primeira o teste passou, mas eu quebrei a build, hahah, esta é uma dica útil ;)
Considero até aqui apenas como uma introdução e contexto, vamos agora realmente entrar dentro do código do Crystal.
Se você leu a issue, tinha um problema de alteração do tipo, valores estavam sendo convertidos para i32 se não havia um enum base type sendo especificado e assumido como padrão (i32), é crucial entender os termos utilizados no problema, isto tornará mais fácil pesquisar no código.
Comecei procurando os testes com algo similar (crystal usa o c_ prefixo para os bindings de C, como isto é um problema em binding da biblioteca padrão C, comecei nestes arquivos).
Encontrei o spec/compiler/type_inference/c_enum_spec.cr e adicionei o seguinte teste (com base em outros testes) para torná-lo vermelho:
it "errors if enum value is different from default (Int32) (#194)" do
assert_error "lib LibFoo; enum Bar; X = 0x00000001_u32; end; end;
LibFoo::Bar::X",
"enum value must be an Int32"
end
ps: É uma convenção do Crystal adicionar (#123) para identificar a issue que o teste esta cobrindo.
Agora era a hora de torná-lo verde, como fazer isto? Era a hora de trabalhar no código fonte do compilador.
Até onde eu lembro das aulas de compiladores, não seria um trabalho léxico porque os tokens foram identificados corretamente, apenas a semântica estava errada. Então dentro de src/compiler/crystal, encontrei a pasta semantic e pesquisei por enum exception being triggered.
Então, encontrei esta exceção acontecendo, e pensei legal, encontrei a verificação de valor da enumeração, vamos começar trabalhando neste pedaço do código.
Depois de algum tempo, eu tornei verde com o código
Este verifica o enum base type (é o padrão se o valor é i32), e em seguida se nenhum valor é i32 a exceção é lançada. (qualquer questionamento sobre isto, deixe nos comentários)
Rodei make clean crystal spec e tive certeza que tudo estava ok.
ps: Não esqueça de rodar crystal tool format para formatar o código fonte.
Depois de tudo isso, PR aberto!
Esta contribuição foi um momento bem divertido, e gostaria de enumerar algumas razões:
Eu gostaria de agradecer @jhass por toda paciência e apoio durante esta jornada.
Eu espero que este post sirva de inspiração para outros contribuidores, depois de lerem isto, você considera contribuir com o Crystal ou alguma outra linguagem de programação?