Desenvolvimento#

Angie é um projeto de código aberto que recebe bem todos os contribuidores.

Código-Fonte#

Você pode clonar o código-fonte do Angie de nossos repositórios públicos: Mercurial, Git.

Estilo de Codificação#

Suas alterações devem ser consistentes com o restante do código do Angie; as convenções de codificação são um bom ponto de partida.

Dica

Em caso de dúvida, examine o código próximo para seguir seu exemplo, ou simplesmente use grep na base de código para inspiração.

Mensagens de Commit#

Historicamente, o log de commits é mantido em inglês.

Comece com um resumo de uma linha do que foi feito. Ele pode ter um prefixo que o log de commits usa para a porção de código afetada. O resumo pode ter até 67 caracteres de comprimento e pode ser seguido por uma linha em branco e mais detalhes.

Uma boa mensagem conta o que causou a mudança, o que foi feito sobre isso, e qual é a situação agora:

API: bad things removed, good things added.

As explained elsewhere[1], the original API was bad because stuff;
this change was introduced to improve that aspect locally.

Levels of goodness have been implemented to mitigate the badness;
this is now the preferred way to work.  Also, the badness is gone.

[1] https://example.com

Detalhes que podem passar despercebidos:

  • O resumo termina com um ponto e começa com letra maiúscula.

  • Se um prefixo é usado, ele é seguido por uma letra minúscula.

  • Espaço duplo separa frases dentro de uma única linha.

Verificações Finais#

  • Faça o seu melhor para verificar que as alterações funcionam em todas as plataformas alvo.

  • Para cada plataforma, execute a suíte de testes para garantir que não há regressão:

    $ cd tests
$ prove .

    Veja o arquivo tests/README para detalhes.

  • Certifique-se de que está confortável com os termos legais.

Enviando Contribuições#

Para enviar um patch, crie um pull request em nosso espelho do GitHub.

Para perguntas e sugestões, entre em contato com os desenvolvedores via GitHub Issues.