From 90ab64a74ae542e0be51a9a855be12dc60b9e2c0 Mon Sep 17 00:00:00 2001 From: Thayanne Sousa Date: Tue, 18 Aug 2020 21:42:06 -0300 Subject: [PATCH] Adiciona template de projeto open source --- .github/ISSUE_TEMPLATE/funcionalidade_nova.md | 23 ++++++ .github/ISSUE_TEMPLATE/reportar_problema.md | 31 ++++++++ .github/PULL_REQUEST_TEMPLATE.md | 20 ++++++ CODE_OF_CONDUCT.md | 71 +++++++++++++++++++ CONTRIBUTING.md | 0 README.md | 35 ++++++++- 6 files changed, 179 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE/funcionalidade_nova.md create mode 100644 .github/ISSUE_TEMPLATE/reportar_problema.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE/funcionalidade_nova.md b/.github/ISSUE_TEMPLATE/funcionalidade_nova.md new file mode 100644 index 0000000..0dd89c7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/funcionalidade_nova.md @@ -0,0 +1,23 @@ +--- +name: Requisição de funcionaliade nova +about: Peça uma nova funcionalidade para o projeto +title: "" +labels: "" +assignees: "" +--- + +**Descreva a feature em detalhes** + + + +**Necessidade da feature:** + + + +**Como ela pode ser implementada:** + + + +**Contexto adicional:** + + diff --git a/.github/ISSUE_TEMPLATE/reportar_problema.md b/.github/ISSUE_TEMPLATE/reportar_problema.md new file mode 100644 index 0000000..71ce02e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/reportar_problema.md @@ -0,0 +1,31 @@ +--- +name: Reportar Problema +about: Reporte um problema ou bug e ajude-nos a melhorar +title: "" +labels: "" +assignees: "" +--- + +**Descreva o bug** + + + +**Reprodução do bug** +Passos para reproduzir o comportamento indesejado: + +1. Vá para '...' +2. Clique em '....' +3. Role até '....' +4. Veja o erro + +**Comportamento desejado** + + + +**Capturas de tela** + + + +**Contexto adicional** + + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..b65a23d --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,20 @@ +#### Issue + + + +# + +#### Qual o objetivo dessa Pull Request? + + + +#### Que problema está resolvendo? + + + + +#### Como pode ser manualmente testado? + +#### Capturas de tela + + diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..d09d5fd --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,71 @@ +# Código de Conduta para Colaboradores + +## Nossa promessa + +Com o interesse de fomentar uma comunidade aberta e acolhedora, +nós, como colaboradores e administradores deste projeto, comprometemo-nos +a fazer a participação deste projeto uma experiência livre de assédio +para todos, independentemente da aparência pessoal, deficiência, +etnia, gênero, idade, identidade ou expressão de gênero, identidade +ou orientação sexual, nacionalidade, nível de experiência, porte físico, +raça ou religião. + +## Nossos padrões + +Exemplos de comportamentos que contribuem a criar um ambiente positivo incluem: + +- Usar linguagem acolhedora e inclusiva +- Respeitar pontos de vista e experiências diferentes +- Aceitar crítica construtiva com graça +- Focar no que é melhor para a comunidade +- Mostrar empatia com outros membros da comunidade + +Exemplos de comportamentos inaceitáveis por parte dos participantes incluem: + +- Uso de linguagem ou imagens sexuais e atenção ou avanço sexual indesejada +- Comentários insultuosos e/ou depreciativos e ataques pessoais ou políticos (_Trolling_) +- Assédio público ou privado +- Publicar informação pessoal de outros sem permissão explícita, como, por exemplo, um endereço eletrônico ou residencial +- Qualquer outra forma de conduta que pode ser razoavelmente considerada inapropriada num ambiente profissional + +## Nossas responsibilidades + +Os administradores do projeto são responsáveis por esclarecer os padrões de +comportamento e deverão tomar ação corretiva apropriada e justa em resposta +a qualquer instância de comportamento inaceitável. + +Os administradores do projeto têm o direito e a responsabilidade de +remover, editar ou rejeitar comentários, commits, código, edições +na wiki, erros ou outras formas de contribuição que não estejam de +acordo com este Código de Conduta, bem como banir temporariamente ou +permanentemente qualquer colaborador por qualquer outro comportamento +que se considere impróprio, perigoso, ofensivo ou problemático. + +## Escopo + +Este Código de Conduta aplica-se dentro dos espaços do projeto ou +qualquer espaço público onde alguém represente o mesmo ou a sua +comunidade. Exemplos de representação do projeto ou comunidade incluem +usar um endereço de email oficial do projeto, postar por uma conta de +mídia social oficial, ou agir como um representante designado num evento +online ou offline. A representação de um projeto pode ser ainda definida e +esclarecida pelos administradores do projeto. + +## Aplicação + +Comportamento abusivo, de assédio ou de outros tipos pode ser +comunicado contatando a equipe do projeto [INSIRA O ENDEREÇO +DE EMAIL]. Todas as queixas serão revistas e investigadas e +resultarão numa resposta necessária e apropriada à situação. +A equipe é obrigada a manter a confidencialidade em relação +ao elemento que reportou o incidente. Demais detalhes de +políticas de aplicação podem ser postadas separadamente. + +Administradores do projeto que não sigam ou não mantenham o Código +de Conduta em boa fé podem enfrentar repercussões temporárias ou permanentes +determinadas por outros membros da liderança do projeto. + +## Atribuição + +Este Código de Conduta é adaptado do [Contributor Covenant](https://www.contributor-covenant.org), +versão 1.4, disponível em https://www.contributor-covenant.org/pt-br/version/1/4/code-of-conduct.html diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..e69de29 diff --git a/README.md b/README.md index 731c581..bb77840 100644 --- a/README.md +++ b/README.md @@ -1 +1,34 @@ -# oss-template \ No newline at end of file +# oss-template + +> Pequena descrição do que seu projeto faz. + + + +Um template para seu projeto Open Source contendo os arquivos essenciais. Mude os tópicos desse `README.md` para conter as informações necessárias do seu projeto. Nesse template irá conter: + +- `README.md`: Uma estrutura básica para descrever o que é seu projeto e como utilizá-lo. +- `LICENSE`: A licença está como **MIT**, edite para outra caso necessário. Use o [choosealicense](https://choosealicense.com/) para ajudar. +- `CONTRIBUTING.md`: Arquivo opcional onde pode conter mais detalhes de como contribuir para seu projeto. +- `CODE_OF_CONDUCT.md`: Código de conduta baseado no [Contributor Covenant](https://www.contributor-covenant.org). Adapte se necessário. +- `github/ISSUE_TEMPLATE`: Template para issues. +- `github/PULL_REQUEST_TEMPLATE`: Template para pull requests. + +## Como Usar + + + +## Desenvolvimento + +Descreva quais tecnologias necessárias para sua aplicação funcionar e adicione referências. + +``` +caso sua aplicação exija um comando para rodar, coloque aqui. +``` + +## Como Contribuir + + + +## Licença + +MIT © [SeuProjeto]()