Bem-vindo e obrigado por considerares contribuir para este repositório de MIEI. São pessoas como tu que fazem a diferença.
Leres estas diretrizes vai facilitar todo o processo para a tua contribuiçao ficar visivel no repositorio. Em troca, irei analisar a tua issue o mais rapido possivel, apresentar alteraçoes necessarias, e finalizar o merge.
Este repositorio segue uma estrutura bastante simples, sendo separado por anos, semestres e cadeiras.
Cada cadeira tem uma pasta prt (prática) e uma pasta trc (teorica). Na prt sao colocados exercicios resolvidos, fichas, testes, projetos, enquanto que na trc são colocados slides dados pelos docentes, livros ou resumos feitos por outros alunos.
Documentaçao nao é obrigatoria, mas ajuda sempre os outros a conseguirem perceber melhor o pretendido.
- Issues/PR bem explicados
- Pode incluir links para commits/issues.
- Codigo documentado
Issues deves ser usadas para informar de algum erro encontrado, sugestoes de melhoria, pedido para resolver um exercicio.
Se ja houver uma issue com o problema em questao, evita criar um nova e participa na já criada, agilizando o processo. Colocando uma reaction ajuda bastante pois indica que mais uma pessoa precisa de ajuda em determinado problema.
Pull request pode ser usado para adicionar o teu proprio conteudo ao repositorio para tal alguns passos tem de ser seguidos.
Se tiveres duvidas de como fazer um pull requests segue os seguintes passos:
- Faz fork do repositorio para a tua conta de github
- Faz clone do teu fork para o teu computador
- Cria uma branch nova com um nome referente ao que vais adicionar.
- Faz as alteraçoes dentro dessa branch e depois faz commit.
- Faz push da tua branch para o teu fork
- Abre um Pull Request para dar merge do teu fork com o repositorio.
Se continuas sem perceber como fazer isto tens aqui um video e um site que explicam passo a passo como fazer isto.