ENTREGA.md

ENTREGA DOS TRABALHOS

Para as práticas do curso de CES27, utilizaremos o Github para entrega dos trabalhos.

Com o objetivo de aproximar os alunos das práticas comuns na indústria de software, vamos utilizar algumas features que a plataforma fornece:

• Fork
• Pull Request
• Code Review

Dado que o foco do nosso curso é o aprendizado e a confiança que é esperada na relação aluno/professor, vamos estabelecer um código de honra para as atividades.

Código de Honra

• Não terei contato com os trabalhos realizados por outros alunos enquanto não tiver entregado o meu trabalho, incluindo trechos de código apresentados nas Pull Requests ou nos repositórios pessoais.
• Todo o código utilizado que não for escrito por mim, terá seu autor ou referência citada.
• Não discutirei detalhes (estruturas, algoritmos e trechos de código) das soluções dos problemas propostos com outros alunos.

Dado isso, fica livre aos alunos compartilharem casos de teste e suas respectivas saídas.

Preparando o repositório no GitHub

Todos os alunos devem possuir uma conta no GitHub.

Acessar o seguinte repositório: CES-27 - Lab 1

Fazer um Fork do repositório clicando no seguinte botão:

Agora associado à sua conta existe uma cópia do repositório do laboratório.

Vamos agora adicionar o seu fork como um repositório remoto do seu repositório local. Altere o trecho CHANGE_USER para o seu usuario do GitHub e execute o comando abaixo:

$ git remote add fork https://github.com/CHANGE_USER/ces27-lab1-part2
$ git remote -v

fork https://github.com/USER/ces27-lab1/ces27-lab1-part2 (fetch)
fork https://github.com/USER/ces27-lab1/ces27-lab1-part2 (push)
origin https://github.com/pauloaguiar/ces27-lab1/ces27-lab1-part2 (fetch)
origin https://github.com/pauloaguiar/ces27-lab1/ces27-lab1-part2 (push)

Enviando a Solução

Antes do envio, tenha certeza de ter dado commit nas suas alterações.

$ git status

Quando estiver pronto para enviar a sua solução, o aluno deve dar push do seu repositório local para o repositório remoto fork:

$ git push fork

Utilizar as suas credenciais do GitHub.

Com a sua solução já no seu repositório remoto, você deve ir até a página do mesmo e criar uma pull request:

https://github.com/CHANGE_USER/ces27-lab1

Ná página seguinte você pode verificar as alterações que estão sendo enviadas.

Quando concluir, clicar no botão mostrado abaixo:

Preencher os dados da pull request.

• Se for a solução final, especificar com o título Solução do Lab ou similar.
• Caso seja uma dúvida, pedido de code review ou outro, especifica no título o pedido e colocar na descrição os detalhes, podendo também adicionar comentários diretamente na visualização das alterações do código.

A primeira pull request deve ser feita no branch master do repositório base. Após isso será criada um branch com nome igual ao seu usuário do GitHub no repositório base. Todos os pull requests seguintes devem ser feitos diretamente nesse novo branch.

Você pode enviar mais de um pull request com a sua solução, somente o estado final do seu branch até a data limite será considerado.

Code Review

Os alunos podem, a qualquer momento dentro do prazo estabelecido para code review, enviar uma pull request (ver procedimento de pull request acima) onde o aluno pode pedir uma revisão do seu código ou tirar alguma dúvida (podendo apresentar apenas uma solução parcial).

Colaborando

Todos os alunos estão convidados a colaborar com o conteúdo da prática, propondo mudanças, relatando erros ou enviando pull requests com melhorias.

Para relatar erros, por favor utilizar a ferramenta Issues do github no seguinte link:

Issues

Para enviar propostas de alterações, basta utilizar a ferramenta de pull request como mostrada acima, descrevendo nos comentários a mudança proposta. Nesse caso você deve fazer a request para o branch master do repositório base.