Contribuindo

Nós adoramos a sua contribuição! Queremos deixar o processo de contribuir para este repositório o mais fácil e transparente possível, independente se é para:

Reportar um bug
Discutir o estado atual do código
Enviar uma correção
Propor novas funcionalidades
Se tornar um mantenedor

Nós Desenvolvemos com o Github

Usamos o GitHub para hospedar o código, rastrear issues e solicitações de recursos e aceitar Pull Requests.

Reporte Bugs usando os issues do GitHub

Se você encontrar bugs, erros ou inconsistências no código ou nos documentos deste projeto, informe-nos abrindo um novo issue, mas considere pesquisar os problemas existentes primeiro para verificar se o problema já foi relatado. Se tiver, nunca é demais adicionar um rápido "+1" ou "Eu também tenho esse problema". Isso ajuda a priorizar os problemas e solicitações mais comuns.

Escreva Relatórios de Bug com Detalhes, Contexto e Código de Amostra

Este é um exemplo de um bom relatório de bug por @briandk. Aqui está outro exemplo de craig.hockenberry.

Ótimos relatórios de bug tendem a ter:

Um resumo e/ou contexto rápido
Passos para reproduzir
- Seja específico!
- Forneça um código de amostra, se puder. O relatório de bug do StackOverflow inclui código de amostra que qualquer pessoa com uma configuração básica de R pode executar para reproduzir o que eu estava vendo
O que você esperava que acontecesse
O que realmente acontece
Observações (possivelmente incluindo por que você acha que isso pode estar acontecendo ou coisas que você tentou que não funcionaram)

As pessoas adoram relatórios de bug completos. Sem brincadeira.

Envie Alterações de Código por meio de Pull Requests

Pull Requests simples para corrigir erros de digitação, documentar ou corrigir pequenos bugs são sempre bem-vindas.

Pedimos que melhorias mais significativas para o projeto sejam propostas, antes que alguém comece a programar, como um issue ou como uma Pull Request de rascunho, que é um novo recurso interessante que dá a outros contribuidores a chance de apontar a direção certa, dar feedback sobre o design e talvez discutir se o trabalho relacionado já está em andamento.

Use um Estilo de Programação Consistente

Recuamos usando dois espaços (soft tabs)
SEMPRE colocamos espaços após os itens da lista e parâmetros do método ([1, 2, 3], não [1,2,3]), ao redor dos operadores (x + = 1, não x + = 1) e ao redor de setas hash.
Este é um software de código aberto. Considere as pessoas que lerão seu código e faça com que ele tenha uma boa aparência para elas. É como dirigir um carro: talvez você adore fazer zerinhos quando está sozinho, mas com os passageiros o objetivo é tornar a viagem o mais suave possível.

Use Github Flow para Pull Requests

Usamos Github Flow. Ao enviar Pull Requests, por favor:

Faça um fork do repo e crie seu branch a partir do master.
Se você adicionou um código que deve ser testado, adicione testes.
Se você alterou APIs, atualize a documentação.
Certifique-se de que o conjunto de testes seja aprovado.
Certifique-se de que seu código passe por um lint.
Emita essa Pull Request!

Envie Sob a Licença de Patente BSD-2-Clause Plus

Resumindo, quando você envia alterações de código, seus envios são considerados disponíveis sob a mesma licença CC-BY que cobre o projeto. Também pedimos que todos os contribuidores de código do GPG assinem o Contrato de Licença de Contribuidor (CLA.md) para proteger futuros usuários deste projeto. Sinta-se à vontade para entrar em contato com os mantenedores se isso for um problema.

Referências

Partes deste documento CONTRIBUTING.md foram adotadas a partir das melhores práticas de uma série de projetos de código aberto, incluindo:

4.7 KiB Raw Blame History