Skip to content

Latest commit

 

History

History
41 lines (23 loc) · 2.28 KB

CONTRIBUTING.md

File metadata and controls

41 lines (23 loc) · 2.28 KB

Descrição do Projeto

Este projeto utiliza dados abertos da Câmara dos Deputados do Brasil, incluindo informações sobre políticos, proposições de leis, reuniões, eventos e outros dados resultantes do processamento realizado pela API.

Ele conecta os dados de uma forma fácil para que você possa acessar informações de quase qualquer lugar dentro da aplicação.

O projeto utiliza o framework Vue3.

✨ Contribuições são bem-vindas!

Destaques das nossas bibliotecas internas

Aqui listamos algumas das bibliotecas que utilizamos, para que você possa se familiarizar com elas:

Conhecendo os Dados

Os dados são extraídos de: https://dadosabertos.camara.leg.br/

Eles também fornecem os endpoints em uma interface Swagger, onde cada um possui uma boa descrição do que deve ser recuperado e um botão "Experimente".

Para este projeto, sempre utilizamos o formato JSON.

Mensagens de Compromisso (Commits)

Seguimos esta convenção para tornar as mensagens de compromisso padronizadas:

  • Todas as primeiras linhas das mensagens de compromisso devem ter no máximo 50 (70 se realmente necessário) caracteres. Use a segunda linha e seguintes para fazer quaisquer explicações adicionais.
  • Os commits devem estar em inglês
  • Comece o commit com: Fix (bugs), Add (para novas funcionalidades, dependencias e afins), Remove (para remoção de códigos, dependências e etc.)

Issues

Ao abrir issues, tente ser claro, forneça exemplos e/ou trechos de código. Alguns templates estão disponíveis para criação das issues, tente abrir a issue usando algum desses templates.

Você pode sugerir abordagens de implementação, correções, etc. Às vezes, precisamos tomar decisões difíceis sobre implementar algo ou não, mas como o projeto é de código aberto, você pode criar seu próprio fork para suas ideias mais urgentes ou "recusadas".

⚠️ Sobretudo, seja respeitoso ao discutir as issues, este deve ser um ambiente amigável para qualquer pessoa interessada no projeto.