Para cooperar com o projeto, a seção issues do repositório está disponível. Existe a necessidade de seguir algumas instruções, apresentadas neste local, buscando melhorar a organização do mesmo e do projeto, conforme abaixo.
As labels (etiquetas, em tradução livre) são, de certa forma, referências criadas para facilitar a identificação de uma nova issue, conforme sua responsabilidade. Atualmente, existem 7 (sete) principais:
- artigo: referencia a requisição de inclusão de um novo artigo no banco;
- duvidas: caso a pessoas tenha alguma duvida referente ao projeto;
- correção: informa a apresentação de erros, sejam ortográficos ou visuais da aplicação;
- documentação: referencia a requisição de uma nova documentação no banco;
- livros: adiciona a requisição de um novo livro no banco;
- melhoria: apresenta uma ideia nova de melhoria pra o projeto;
- problema/bugs: caso encontre algum problema, informe imediatamente por meio desta label;
- projetos: referencia um novo projeto que esteja em andamento de tradução.
Algumas destas labels representam formas de complementar as issues e, por isso, elas têm grande importância.
Primeiramente, existe a necessidade de criação de uma nova issue. Caso esta represente a adição de um novo problema ou melhoria, basta cadastrá-la com o título nas seguintes estruturas:
[Problema/Bugs] - Tipo de Problema Encontrado
[Melhoria] - Tipo de Melhoria
Todas as outras opções devem seguir a mesma estrutura, apenas mudando o tipo de label dentro das chaves []. Para descrever um problema ou melhoria, há a necessidade de inclusão de uma breve descrição da mesma e, se possível, exemplificá-lo, tornando mais fácil a explicação. Agora, caso seja desejado o cadastro de um novo documento, será preciso a apresentação do link do mesmo, seguindo as estruturas anteriores.
Em Breve.