Skip to content

Latest commit

 

History

History
71 lines (52 loc) · 3.21 KB

CONTRIBUTING.md

File metadata and controls

71 lines (52 loc) · 3.21 KB
Raw

📝 Guia de Contribuição

Olá! Obrigado pelo interesse em contribuir com este repositório de estudos. Este espaço foi criado para compartilhar materiais e ajudar outros alunos, então, ficamos felizes em receber novas contribuições. Para manter tudo organizado e útil para todos, siga as diretrizes abaixo.

🧩 Como Contribuir

1. Fork o Repositório

  1. Clique em "Fork" no canto superior direito da página para criar uma cópia do repositório em sua conta.
  2. Clone o fork para sua máquina local: 
    git clone https://github.com/vinimiraa/Estudos.git

2. Crie uma Branch para Sua Contribuição

  1. Crie uma nova branch com um nome que descreva sua contribuição: 
    git checkout -b minha-contribuicao
  2. Use um nome de branch claro e descritivo. Exemplos:
    • resumo-aeds-arvores-binarias
    • codigo-lp-funcoes-recursivas

3. Adicione Seus Arquivos

  • Resumos: Se adicionar um novo resumo, certifique-se de que está na pasta correta (por exemplo, /Resumos/AEDs) e com um nome descritivo. Use o formato .md (Markdown) para garantir consistência.
  • Códigos: Organize o código na pasta correta e adicione comentários explicativos quando necessário. Inclua um breve README.md na subpasta, se o código for mais complexo.
  • Materiais: PDFs ou outros materiais de apoio devem ser colocados na pasta Materiais sob a disciplina correspondente.

4. Atualize os README.md e Outros Arquivos

  1. Resumos/Códigos/Materiais: Atualize o README.md da respectiva pasta se estiver adicionando ou alterando conteúdo.
  2. README.md Principal: Caso adicione um tópico importante, considere atualizar a estrutura principal no README.md.

5. Faça um Commit

  1. Realize commits com mensagens claras e detalhadas. Use o formato: 
    git commit -m "Resumo de árvores binárias adicionado em AEDs"
  2. Commits pequenos e específicos são preferíveis para facilitar a revisão.

6. Envie a Branch e Abra um Pull Request

  1. Envie sua branch para o GitHub: 
    git push origin minha-contribuicao
  2. Abra um Pull Request (PR) no repositório original. Descreva o que foi adicionado, modificado ou corrigido e inclua qualquer outra informação relevante.

📋 Diretrizes de Formatação e Organização

  • Markdown: Use o formato Markdown (.md) para resumos, e adicione seções e formatação clara.
  • Nomenclatura: Mantenha nomes de arquivos e pastas consistentes, descritivos e em português.
  • Comentários no Código: Comente o código de forma clara para facilitar o entendimento.
  • Padronização: Utilize o mesmo estilo de nome para arquivos semelhantes (ex.: Resumo_AEDs_Arvores.md).

🚀 Sugestões de Contribuição

  • Resumos: Adicione novos resumos de tópicos não cobertos ou complemente os já existentes com detalhes adicionais.
  • Exercícios Resolvidos: Se você tem exercícios resolvidos, adicione-os com uma explicação detalhada para ajudar outros alunos a entenderem.
  • Dicas de Estudo: Compartilhe materiais, dicas, ou links úteis sobre uma disciplina.
  • Correções: Se encontrar algum erro, seja em código, formatação ou conteúdo, sinta-se à vontade para corrigir.