Olá pessoal!
Concluindo um módulo do Bootcamp Java, surgiu uma dúvida sobre como organizar minhas pastas e arquivos de forma que fique claro para pessoas que não têm conhecimento técnico, ou para tech recruiters que poderão acessar meu GitHub no futuro. Como vocês costumam se organizar? Gostaria de ver exemplos de como vocês lidam com isso. Desde já, muito obrigado!
Olá Martis. Não existe um padrão, existem modelos que podem ser adaptados. No meu caso uso o padrão do livro Python Levado à Sério (não consigo anexar o diagrama), para projeto simples o padrão que uso é mais modesto.
./meuApp
..../docs
..../src
....app.py
..../tests
.README.md
docs: manual de uso
src: código principal
tests: facilitar testes ou uso de mecanismos para documentação automática ou correção de código (Sphinix, Ruff...)
Valeu @Mazolene. Isso é interessante mesmo. E conforme você avença o curso, como vai fazer. Vou iniciar POO agora, pensei em fazer uma nova pasta, pra separar básico do intermediário. Não sei se faz muito sentido.
Também estou iniciando e também me fiz essa pergunta. Irei tentar ajudar na medida do possível e através das minhas pesquisas na web:
Criar um README.md na raiz do repositório: O arquivo README é fundamental para dar uma visão geral do seu projeto, a professora Elidiana Andrade deixou muito bem explicado essa informação no curso Versionamento de código. Essa informação pesquisei no Google: "Organizar as pastas de forma significativa : Divida seus arquivos em pastas com nomes claros e autoexplicativos, como:
src/(ou code/) - Contém os arquivos-fonte do seu projeto
tests/- Abriga os testes automatizados
docs/- Guarda a documentação do projeto
resources/- Contém arquivos de configuração, imagens, etc. Utilização README.md nas pastas importantes : Além do README na raiz, considere incluir arquivos README em pastas específicas, como src/e docs/"
Seguir boas práticas de versionamento : Utilize um fluxo de trabalho de versionamento, como o Git Flow, para manter um histórico claro de commits e ramificações.
Aprendi muito no curso da Elidiana Andrade, mas fiquei bem perdido também, fiz diversas pesquisas e, à medida que o cursos avança, a gente utiliza bastante o repositório.
LR
