como contribuir Page History

Como contribuir

Como criar uma issue

Issues é como chamamos as tarefas que serão criadas no projeto quando necessitar fazer alguma alteração no software, na documentação ou até mesmo discutir sobre algum assunto sobre o projeto. Link para acessar a página de issues

Para cadastrar uma issue no repositório do i-Educar, é preciso respeitar a seguinte estrutura:

Escopo

MENU: Nesta seção deve ser apontado qual o menu no sistema deve ser realizada a alteração.

DESCRIÇÃO: Nesta seção deve ser colocado uma descrição do problema ou necessidade.

OBSERVAÇÕES: Observações em geral sobre o problema apontado.

Exemplo:

**MENU:**

i-Educar - Escola > Cadastro > Turma > Cadastrar

**DESCRIÇÃO:**

No cadastro de turmas, ao selecionar a opção Multi-seriada, todas as séries aparecem para seleção, quando deveria ser somente as da escola e curso selecionado.

**OBSERVAÇÕES:**

Não se aplica.

Veja um exemplo de uma issue cadastrada: https://softwarepublico.gov.br/gitlab/i-educar/i-educar/issues/28

Se você tiver dificuldade de formatar (negrito por exemplo), veja como fazer com o Markdown: https://softwarepublico.gov.br/gitlab/help/markdown/markdown

Labels

ambiente: Usado quando a issue se trata de algo referente ao ambiente (servidor) em que o i-Educar estará rodando. (Exemplo: Atualização de alguma dependência)

bug: Usado quando a issue reporta algum erro, seja de análise ou da aplicação.

discussão: Usado quando a issue for utilizada para discutir com outros membros uma situação que deve ser definida dentro do projeto i-Educar. (Exemplo: definir qual a melhor forma de atender uma situação específica)

documentação: Usado quando a issue reporta uma melhoria ou ajuste na documentação da Wiki.

melhoria: Usado quando a issue reporta uma melhoria de alguma funcionalidade existente (Exemplo: em um cadastro ou processo, ou em um campo existente em alguma funcionalidade).

novidade: Usado quando a issue reporta uma nova funcionalidade que até então ainda não existia, nova funcionalidade pode ser um novo cadastro / processo, ou uma nova funcionalidade (como um campo ou pesquisa ou validação, etc...) em um cadastro / processo existente.

otimização: Usado quando a issue reporta uma alteração que trará uma melhoria no desempenho de algum processo. (Exemplo: alteração de um sql para retornar uma consulta mais rapidamente)

refatoração: Usado quando necessário fazer uma reescrita em alguma parte do código, mas que não será visível para o usuário.

Como obter o repositório do i-Educar (Git)

Obtendo repositório via terminal - Linux

  • Acesse o repositório do i-Educar disponível na comunidade através do GitLab.
  • Realize um fork do repositório, clicando na opção "fork" no canto superior direito da página do repositório, conforme exemplo abaixo:

Screenshot

  • Realize um clone do repositório forkado, executando o seguinte comando no terminal.

git clone git@softwarepublico.gov.br:[nome_do_usuario]/i-educar.git

  • Agora é só aguardar o download do projeto.

Implementar a solução de um problema/necessidade relatado

  • Após obter o repositório do i-Educar, faça as suas alterações localmente.

  • Ao terminar, suba essas alterações para o repositório através de um commit.

git push

  • Realizar um merge request para o repositório principal do i-Educar na comunidade.

Observação: Referenciar a issue que originou a alteração a ser comitada. Isto pode ser feito ao realizar o commit ou após realizar o commit, fazendo um comentário no mesmo.

É de extrema importância que não existam commits sem referência de uma issue.

Para referenciar a issue, deve ser adicionado o seguinte texto:

i-educar/i-educar#numerodaissue

Imagem de exemplo

Last edited by Tiago Giusti