Skip to content

1.1. How To Create Issues

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

1.1.1. Why Create Issues

It is important in a project to create the issues, in that it is an efficient way to communicate to team the problems, questions and needs for which the project and developers comes through. Especially when teams are large enough and the communication it's just remote. Thus, it is crucial that there be a minimum of documentation of problems and needs of the project, how they were solved, who decided etc.

1.1.2. About the Standard

1.1.2.1. The Language

AkanAndroid is a project developed by Brazilians in order to provide for Brazilians a easier way to visualize spending their elected to Congress. It is therefore important that all of your documentation can be viewed by any and all Brazilian. However, it is also important that the developer community can have visibility of what happens in the project, if any interest in contributing to it. In this sense, the AkanAndroid documentation must be bilingual in both Portuguese as in English.

1.1.2.2. The Standard

Follow the standard to create a issue for unit test.

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