Skip to content

2.1. Como Criar Issues

Tomaz Martins edited this page Jul 26, 2015 · 2 revisions

2.1.1. Por que Criar Issues

É importante num projeto a criação das issues, na medida em que é uma forma eficiente de comunicar à equipe os problemas, dúvidas e necessidades pelas quais o projeto e os desenvolvedores vem passando. Ainda mais quando as equipes são grandes a ponto de não haver muita comunicação externa ao ambiente de trabalho que, muitas vezes, é apenas remoto. Dessa forma, é crucial que haja um mínimo de documentação dos problemas e necessidades do projeto, como foram resolvidos, quem resolveu etc.

2.1.2. Sobre o Padrão

2.1.2.1. O Idioma

AkanAndroid é um projeto desenvolvido por brasileiros com o intuito de fornecer aos brasileiros maior facilidade em visualizar os gastos de seus eleitos ao Congresso Nacional. Portanto, é importante que toda a sua documentação possa ser vista por todo e qualquer brasileiro. No entanto, é importante também que a comunidade de desenvolvedores possa ter visibilidade do que ocorre no projeto, caso haja algum interesse em contribuir com ele. Nesse sentido, a documentação do AkanAndroid deve ser bilíngue, tanto em português quanto em inglês.

2.1.2.2. O Padrão

Segue abaixo o padrão para criação de issues de testes unitários.

# <Title of Issue>
## Description
**English:** <brief description of the issue>

**Portuguese:** <breve descrição sobre a *issue*>

## Failure Trace
<an image of the failure trace>

## Suggested Repair
**English:** <a text that reflects your opinion the cause and how to fix the problem>

**Portuguese:** <um texto que reflita a sua opinião a causa e como reparar o problema>