Skip to content

Contribuindo com o PDF2CA$H.

Agredecemos sua vontade em contribuir com nosso projeto. A seguir encontram-se algumas diretrizes para aqueles que desejam realizar contribuições junto ao PDF2CA$H.

Código de conduta

Ajude-nos a manter o bom convivio de nossa comunidade ao ler e seguir o nosso código de conduta.

Como contribuir

Reportando bugs

Caso tenha descoberto um bug e deseja fazer um report do mesmo por favor submita uma issue seguindo este template.

Sugerindo melhorias

Caso tenha sugestões de melhorias ou deseja fazer um pedido de uma nova feature por favor submita uma issue seguindo este template.

Pull Requests

Guia de estilo

TODO / TBD

Mensagens do git

  • Sempre use o infinitivo.
  • Usar o inglês.

Certo:

Add new filter.

Errado:

Adding new feature.

  • A primeira linha da mensagem deve ter no máximo 72 caracteres.

  • Use a primeira linha para fazer uma descrição sucinta da mudança proposta do commit. Use as linhas restantes para fazer uma descrição mais detalhas se for preciso.

  • Caso a mudança proposta no commit estiver relacionada à alguma issue favor incluir uma indicação do mesmo da seguinte forma:

    refs # refs #, #, ...

A localização de tal indicação deve ser escolhida segundo as seguintes regras: * Caso o titulo do commit(e.g. primeira linha) suporte a inserção da indicação sem quebrar a regra de 72 caracteres, coloque um ';' ao final da mensagem seguido da indicação. Ex:

Fix a bug in the person's crud; refs #16

  • Caso contrário use uma linha separada para colocar a indicação. Ex:

Implement the search algorithm for cases in which the input is greather than 20

refs: #15, #17.