Templates

Aqui você encontrará exemplos de templates de Pull Requests & Issues. Uma referência é o projeto da Alelo.

Pull Requests

• Crie o arquivo no seguinte diretório: .github/pull_request_template.md
• Em seguida, cole o conteúdo a seguir:

### ✔ Propósito:

_O que existe de novo nessa PR? O que ela resolve?_

### 🔸 Tarefa:

_Podemos copiar o link das tarefa no Asana. Copie o link da tarefa em questão e cole aqui_

### 🔻 Issue:

_Issue(s) - se existirem - referentes ao PR_

### 🔹 Plus:

_Qualquer informação que você ache que seria legal informar. Ex: print do layout, observações, etc..._

Issues

Por ora temos dois tipos de issues: Bug Report e Feature Request.

Bug Report

• Cria o arquivo no seguinte diretório: .github/ISSUE_TEMPLATE/bug_report.md
• Em seguida, cole o conteúdo a seguir:

---
name: Bug report
about: Crie uma issue para nos ajudar a melhorar
title: ''
labels: ''
assignees: ''

---

**Descrição do bug**
Uma descrição simples e concisa do que é o bug.

**Como reproduzir**
Passos para reproduzir o bug:
1. Vá para '...'
2. Clique em '....'
3. Role até '....'
4. Veja o erro

**Comportamento esperado**
Uma descrição simples e concisa do que é esperado.

**Screenshots**
Caso seja aplicado, inclua uma ou mais screenshots.

**Desktop (preencha com as seguintes informações):**
 - OS: [e.g. iOS]
 - Browser [e.g. chrome, safari]
 - Version [e.g. 22]

**Smartphone (preencha com as seguintes informações):**
 - Device: [e.g. iPhone6]
 - OS: [e.g. iOS8.1]
 - Browser [e.g. stock browser, safari]
 - Version [e.g. 22]

**Mais informações**
Qualquer outra informação sobre o problema.

Feature Request

• Cria o arquivo no seguinte diretório: .github/ISSUE_TEMPLATE/feature_request.md
• Em seguida, cole o conteúdo a seguir:

---
name: Feature request
about: Sugira uma ideia para esse projeto
title: ''
labels: ''
assignees: ''

---

**Sua sugestão está relacionada com um problema? Por favor descreva.**
Um descrição clara e concisa do que é o problema.

**Descreva a sugestão de solução**
Um descrição clara e concisa do que você espera.

**Informações adicionais**
Adicione qualquer informação ou screenshots sobre sua sugestão.

Code Owners

Com o Code Owners nós conseguimos deixar por padrão usuários para que quando abrirmos PRs eles sejam automaticamente atribuídos como revisores.

• Para isso, crie o arquivo no seguinte diretório: .github/CODEOWNERS
• Por fim, adicione o conteúdo a seguir:

# This is a comment.
# Each line is a file pattern followed by one or more owners.

# These owners will be the default owners for everything in
# the repo. Unless a later match takes precedence,
# @global-owner1 and @global-owner2 will be requested for
# review when someone opens a pull request.
*       @nncl

# Order is important; the last matching pattern takes the most
# precedence. When someone opens a pull request that only
# modifies JS files, only @js-owner and not the global
# owner(s) will be requested for a review.
*.js    @nncl
*.js    @kvnol

Lembrando: Adicione os nomes dos usuários referentes ao projeto. Caso queira, é possível determinar mais de um revisor por tipo de arquivo.