Skip to content

Commit

Permalink
Adiciona template de projeto open source
Browse files Browse the repository at this point in the history
  • Loading branch information
thayannevls committed Aug 19, 2020
1 parent 21bf69a commit 90ab64a
Show file tree
Hide file tree
Showing 6 changed files with 179 additions and 1 deletion.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/funcionalidade_nova.md
Original file line number Diff line number Diff line change
@@ -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**

<!-- Descreva a feature e suas características mais importantes. -->

**Necessidade da feature:**

<!-- Descreva o porquê da melhoria ser necessária -->

**Como ela pode ser implementada:**

<!-- Dê ideias de como a melhoria pode ser implementada no projeto -->

**Contexto adicional:**

<!-- Adicione qualquer informação adicional que achar necessária. Imagens, links etc -->
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/reportar_problema.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: Reportar Problema
about: Reporte um problema ou bug e ajude-nos a melhorar
title: ""
labels: ""
assignees: ""
---

**Descreva o bug**

<!-- Uma descrição concisa e clara do que 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**

<!-- Uma descrição clara sobre o comportamento esperado. -->

**Capturas de tela**

<!-- Se aplicável, adicione capturas de tela para ajudar na descrição do problema -->

**Contexto adicional**

<!-- Adicione qualquer outro contexto ao problema reportado aqui -->
20 changes: 20 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
#### Issue

<!-- Marque aqui a issue ao qual essa pull request se refere -->

#<numero_da_issue>

#### Qual o objetivo dessa Pull Request?

<!--- Descreva suas mudanças em detalhes -->

#### Que problema está resolvendo?

<!-- Marque o número da issue que está resolvendo #<numero_da_issue> -->
<!--- Se não tiver issue, descreva a motivação e contexto dessa mudança -->

#### Como pode ser manualmente testado?

#### Capturas de tela

<!-- Se aplicável, se não apague essa seção -->
71 changes: 71 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -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
Empty file added CONTRIBUTING.md
Empty file.
35 changes: 34 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,34 @@
# oss-template
# oss-template

> Pequena descrição do que seu projeto faz.
<!-- Descreva aqui no início os objetivos do seu projeto. -->

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

<!-- Descreva como um usuário pode utilizar seu projeto. -->

## 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

<!-- Descreva informações necessárias para contribuir. Se necessário referencie o CONTRIBUTING.md -->

## Licença

MIT © [SeuProjeto]()

0 comments on commit 90ab64a

Please sign in to comment.