Skip to content

Latest commit

 

History

History
53 lines (32 loc) · 2.18 KB

File metadata and controls

53 lines (32 loc) · 2.18 KB

Diretrizes de Contribuição

Início

Observe que este projeto é lançado com um Código de Conduta do Colaborador. Ao participar deste projeto, você concorda em cumprir seus termos.

Como contribuir

Se você quiser contribuir, comece pesquisando as issues e os pull requests para ver se alguém levantou uma ideia ou pergunta similar.

Se você não vê sua ideia listada e acha que ela se encaixa nos objetivos deste guia, siga um destes procedimentos:

  • Se sua contribuição for pequena, como uma correção de erro de digitação, abra um pull request.

  • Se a sua contribuição for importante, como um novo guia ou exemplo, comece por abrir uma issue primeiro. Dessa forma, outras pessoas podem analisar a discussão antes de você fazer qualquer trabalho.

Caso você não saiba como abrir um pull request veja aqui.

Checklists

Subindo um exemplo

  1. Abra uma issue explicando o que você vai fazer;

  2. Adicione seu exemplo como subpasta do diretório _examples;

    1.1. Caso o seu exemplo pertença a alguma categoria, adicione ele dentro da categoria;

    1.2. Caso não exista a categoria, faça a sugestão da nova categoria na issue que você abriu;

  3. Crie um .md mínimo explicando o seu exemplo. Esse .md pode ser usado como descrição do seu PR. Veja um exemplo.

    2.1 Este arquivo precisa ter os links para voltar para o README.md, como link para o início, e outro com o link para examples.md, como link para voltar;

    Exemplo:

    # Exemplos
    
    [Início](../../../README.md) |
    [Exemplos](../../../examples.md)
    ...
  4. Referencie o seu exemplo no examples.md

    Veja na prática

    Exemplo:

    ## Categoria
    
    * [Exemplo de Contribuição](_examples/contributing/contributingExample/contributingExample.md)
    ...