Skip to content

Latest commit

 

History

History
56 lines (41 loc) · 3.43 KB

CONTRIBUTING.md

File metadata and controls

56 lines (41 loc) · 3.43 KB

Contribuindo com o Boilerplate

Adoramos sua opinião! Queremos tornar a contribuição para este projeto o mais fácil e transparente possível, seja:

  • Relatando um bug
  • Discutir o estado atual do código
  • Enviando uma correção
  • Proposta de novos recursos
  • Tornando-se um mantenedor

Desenvolvemos com Github

Usamos o github para hospedar código, rastrear problemas e solicitações de recursos, bem como aceitar solicitações de pull request.

Nós usamos Github Flow, Portanto, todas as alterações de código acontecem por meio de solicitações Pull Requests

Solicitações Pull requests são a melhor maneira de propor mudanças na base de código (we use Github Flow). Acolhemos ativamente suas solicitações pull request:

  1. Faça um fork do repo e crie seu branch a partir de master.
  2. Se você adicionou código que deve ser testado, adicione testes.
  3. Se você mudou as APIs, atualize a documentação.
  4. Certifique-se de que o conjunto de testes seja aprovado.
  5. Certifique-se de que o seu código seja executado.
  6. Emita essa solicitação pull request!

Quaisquer contribuições que você fizer estarão sob a Licença de Software MIT

Em suma, quando você envia alterações de código, seus envios são considerados sob o mesmo MIT License que cobre o projeto. Sinta-se à vontade para contatar os mantenedores se isso for uma preocupação.

Reportar bugs usando Github's issues

Usamos GitHub issues para rastrear bugs públicos. Reportar um bug até abrindo um novo problema; É tão fácil!

Escreva relatórios de bug com detalhes, histórico e código de amostra

Isto é um exemplo de um relatório de bug que escrevi, e acho que não é um modelo ruim. Aqui está outro exemplo de Craig Hockenberry, um desenvolvedor de aplicativos que respeito muito.

Ótimos relatórios de bug tendem a ter:

  • Um resumo rápido e/ou histórico
  • Passos para reproduzir
    • Seja específico!
    • Forneça um código de amostra, se puder. Minha pergunta stackoverflow inclui código de amostra que qualquer pessoa com uma configuração R de base pode executar para reproduzir o que eu estava vendo
  • O que você esperava que acontecesse
  • O que realmente acontece
  • Notas (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. Eu nem estou brincando.

Use um estilo de codificação consistente

Estou pegando emprestado de novo do Facebook's Guidelines

  • 2 espaços para recuo em vez de tabulações
  • Você pode tentar executar npm run lint para unificação de estilo por exemplo

OBS: Para Linting em C# podemos usar: StyleCop, Sonar e Resharper

Licença

Ao contribuir, você concorda que suas contribuições serão licenciadas sob a Licença MIT.

Referências

Este documento foi adaptado das diretrizes de contribuição de código aberto para Facebook's Draft