dexdevlab/github-repo-template

Template de Repositório do Github com arquivos essenciais e modelos customizáveis

Github Repository Template

Template de Repositório do Github com arquivos essenciais e modelos customizáveis

Conteúdo

Este repositório tem como objetivo apresentar um template para criar facilmente a estrutura básica de qualquer repositório com o mínimo de documentação, organização e automação possíveis, respeitando as regras essenciais de linting e os critérios para manipular os dados de um repositório. Além disso, contém referências para badges, arquivos de licença e modelos de README, bem como scripts de automação do GitHub Actions para facilitar o trabalho do desenvolvedor durante a publicação e organização das versões e releases.

Instruções

Utilizando o repositório como projeto para testar templates e scripts

1 - Faça um git clone ou o download do repositório, da forma que preferir

git clone https://github.com/dexdevlab/github-repo-template.git

Testando os scripts do GitHub Actions

Você pode testar qualquer script contido no diretório 'GitHub Actions' colando o template desejado em '.github/workflows' e poderá ver seu funcionamento no próximo commit que você aplicar no seu repositório clonado.

Configuração mandatória para executar os scripts

É obrigatório realizar este ajuste em qualquer repositório onde deseja que seu workflow funcione, para se certificar de que ele tenha as permissões necessárias para executar suas etapas.

Vá nas Configurações Gerais de Ações do repositório (<https://github.com/><NOME_DO_USUARIO>/<NOME_DO_REPOSITORIO>/settings/actions) e faça os seguintes ajustes:

1 - Marque 'Allow all actions and reusable workflows' em 'Actions permissions'

2 - Marque 'Read and write permissions' em 'Workflow permissions'

Notas de versão

v2.2.0-240427

• Atualização do README
• Novos badges: Vuejs e Material UI
• Nova categoria de badge: Design Systems

v2.1.0-240427

• Alteração do template do README
• Atualização do README
• Novos badges: Chromatic e Storybook
• Alteração da categoria dos badges: Vercel, Netlify e Heroku
• Adição de novo script do Github Actions: Chromatic
• Alteração do nome da pasta dos scripts do Github Actions

v2.0.0-240307

• Adição dos scripts do GitHub Actions e atualização de sintaxe dos mesmos
• Atualização da documentação
• Adição de scripts de limpeza do Yarn
• Adição de script de limpeza do Git para arquivos que continuam sendo monitorados mesmo depois de desmarcados
• Atualização do gitignore, que também pode ser usado como template
• Alteração do badge de versão e release
• Atualização no template de licenças e readme
• Alteração da sintaxe do script do GitHub Actions

v1.2.1-230412

• Atualização da documentação

v1.2.0-230412

• Alteração do estilo dos badges

v1.1.0-230411

• Inclusão de espaço para thumbnail com centralização e ajustes de tamanho e proporção
• Atualização da documentação

v1.0.4-230310

• Atualização da documentação

v1.0.3-230309

• Atualização da documentação

v1.0.2-230309

• Atualização da documentação

v1.0.1-230309

• Ajuste no estilo de layout dos badges

v1.0.0-230309

• Publicação do repositório.

Autores

Contato

Se você gostou deste projeto, dê uma estrela.
Para contato, envie um email a: [email protected]

---

Licença

Licenciado sob a MIT License.