Esse projeto é uma documentação interativa sobre a vida e os ensinamentos de Jesus Cristo, explorando temas como graça, perdão e sacrifício. Nele vamos contar a história de Jesus, desde seu nascimento até sua ressurreição, destacando momentos chave que ilustram esses conceitos centrais do cristianismo.
- Framework: Docusaurus
- Linguagem: TypeScript
- Node.js: >= 18.x (recomendado 22.x)
# Clone o repositório
git clone <url-do-repositorio>
cd the-lamb
# Instale as dependências
npm install
# Execute em modo de desenvolvimento
npm run startAcesse http://localhost:3000 para visualizar a aplicação.
Este projeto utiliza ESLint e Prettier para garantir qualidade e consistência do código.
As regras e definições aplicadas estão nos arquivos abaixo.
| Ferramenta | Arquivo de Configuração | Descrição |
|---|---|---|
| ESLint | eslint.config.mjs |
Regras de linting e integração com Prettier |
| Prettier | .prettierrc |
Regras de formatação de código |
| VS Code | .vscode/settings.json |
Configurações do editor |
💡 Dica: Instale as extensões
ESLintePrettier - Code formatterno VS Code para melhor experiência de desenvolvimento.
Este projeto utiliza Husky para automatizar verificações de qualidade antes dos commits e pushes.
Suas contribuições são muito bem-vindas! Se você tem uma ideia de melhoria, correção de bug ou nova funcionalidade, sinta-se à vontade para abrir uma issue ou pull request. Colaboração e novas perspectivas são altamente valorizadas aqui—vamos construir algo incrível juntos!
Por favor, siga nosso código de conduta em todas as interações com o projeto.
-
Crie uma branch: Sempre crie uma nova branch a partir da
masterusando o padrãofeature/xxx,fix/xxxou outro prefixo apropriado. -
Faça commits pequenos e focados: Cada commit deve representar uma alteração lógica única. Evite commits grandes com muitas mudanças não relacionadas. Isso facilita a revisão e validação do código.
-
Padrão de mensagens de commit: Todos os commits devem seguir a especificação Conventional Commits (Versionamento Semântico). Exemplos:
feat: adicionar funcionalidade de login do usuáriofix: corrigir bug no loginchore: atualizar dependênciasdocs: atualizar READMEtest: adicionar testes para login
Recomendações:
Prefira escrever as mensagens de commit em português e sem acentuação. Isso facilita a padronização e evita problemas de encoding em diferentes sistemas.
Apenas commits do tipo
featefixgeram tag de deploy e disparam uma release. Outros tipos comochore,docs,test, etc., não geram tag de deploy.Commits que não seguirem esse padrão não serão mergeados, pois quebram o processo de geração de release.
Nem todos os commits precisam ser
featoufix, mas sempre use o tipo correto para sua alteração.
-
Pull Request (PR): Abra um PR para a
mastercom um título claro e descritivo. Na descrição do PR, explique o que está sendo feito e por quê. Referencie issues relacionadas, se aplicável. -
Validação: O workflow do PR irá validar seu código. Só é possível fazer merge se todos os checks passarem.
-
Release e Deploy: Para detalhes sobre deploy e versionamento, consulte a seção de Versionamento no README.md.
Importante: O Pull Request só será aceito se passar por todos os checks automáticos definidos no workflow
pr-checks.yml.
Esse fluxo garante qualidade, rastreabilidade e entrega contínua de valor. Seguindo essas orientações você evita erros e agiliza o processo de revisão e release.
Este projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.
