Skip to content

heviane/templates-for-projects

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

58 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Templates para Projetos de Software

Este repositório é uma coleção centralizada de templates, guias e configurações projetados para acelerar o início de novos projetos de software. O objetivo é fornecer uma base sólida e padronizada, garantindo consistência no ambiente de desenvolvimento, na estrutura do projeto e nas práticas de colaboração desde o primeiro dia.


🚀 O que você encontrará aqui?

Este "starter kit" inclui os seguintes recursos para facilitar sua vida:

📁 /.vscode - Ambiente de Desenvolvimento Padronizado

Configurações para o Visual Studio Code que garantem que toda a equipe utilize os mesmos padrões.

  • settings.json: Formatação ao salvar, linter e configurações do editor.
  • extensions.json: Recomendações de extensões essenciais para o projeto.
  • launch.json: Configurações de depuração prontas para uso (ex: Node.js).
  • tasks.json: Tarefas automatizadas para build, teste e outras operações.

📁 /.github - Guias de Colaboração

Templates para facilitar a gestão da comunidade e das contribuições no GitHub.

  • CONTRIBUTING.md: Um guia claro sobre como contribuir com o projeto.
  • ISSUE_TEMPLATE.md: Modelos para reportar bugs e sugerir funcionalidades.
  • PULL_REQUEST_TEMPLATE.md: Um modelo para garantir que os PRs sejam claros e completos.

📁 /docs - Documentação e Guias

Documentos úteis para guiar os desenvolvedores.

  • Sugestões de Estrutura de Projetos: Exemplos de como organizar projetos (Node.js, Front-end/Back-end).
  • Guias Práticos: Tutoriais passo a passo para tarefas comuns, como versionar um novo projeto no GitHub.
  • Modelos de Templates: Exemplos e modelos prontos para uso.

📄 .editorconfig - Consistência de Código

Um arquivo de configuração para manter um estilo de código consistente (indentação, final de linha, etc.) em diferentes editores e IDEs.


🛠️ Como Usar

  1. Clone ou baixe este repositório.
  2. Copie os arquivos e diretórios desejados (como .vscode, .github, .editorconfig) para a raiz do seu novo projeto.
  3. Adapte os arquivos conforme necessário. Por exemplo, atualize os nomes e descrições no CONTRIBUTING.md e outros documentos.

Com isso, seu novo projeto já começará com uma base organizada e padronizada!


🤝 Como Contribuir

Contribuições são muito bem-vindas! Se você tem um template útil, uma melhoria para um guia existente ou uma nova ideia, sinta-se à vontade para abrir uma Issue ou um Pull Request.

Por favor, leia nosso guia de contribuição em Guia de Contribuição para mais detalhes.

About

Templates e documentações para projetos de software

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 17