Contribuindo

Obrigado pelo seu interesse em contribuir para o Urbis! Aceitamos contribuições tanto para o código quanto para a documentação.

Antes de Começar

Antes de enviar um pull request (PR), é fortemente recomendado criar uma issue para discutir suas alterações propostas. Isso ajuda a alinhar suas contribuições com os objetivos do projeto e evita esforços duplicados.

Se você não tem certeza se suas alterações são necessárias, sinta-se à vontade para abrir uma issue para discussão.

Fazendo Alterações

Para contribuir:

1. Faça um Fork e clone o repositório.
2. Crie um branch separado para suas alterações.
3. Faça suas alterações, garantindo que estejam bem formatadas e passem nos testes.
4. Escreva ou atualize testes, se necessário.
5. Execute pnpm build e depois execute os testes com pnpm test.
6. Envie seu branch e abra um pull request (PR).

Seu PR será revisado e, se tudo estiver certo, merged dentro de alguns dias.

Regras de Código

• Todas as funcionalidades ou correções de bugs devem ser testadas com testes apropriados.
• Métodos da API pública devem ser documentados.
• Siga o estilo de código do projeto e garanta a formatação adequada.