Victoreisdavid / FiscalizaJa

FiscalizaJá: Despesas dos deputados federais, ao fácil acesso.
https://www.fiscalizaja.com
GNU General Public License v3.0
18 stars 2 forks source link

Padronizar o idioma do código #3

Open juaoantonio opened 1 year ago

juaoantonio commented 1 year ago

Muitas das vezes, há uma mistura entre inglês e português, talvez se proveitoso manter tudo em inglês, facilitando a entrada de novos colaboradores.

Victoreisdavid commented 1 year ago

Boa noite!

Eu queria manter tudo em inglês, mas a Api dos dados abertos retorna tudo em português, isso me deixou bastante confuso durante o decorrer do projeto 😅.

Padronizar o idioma é uma das coisas que quero fazer, inclusive, se quiser ajudar, será bem vindo! ❤

wellwelwel commented 1 year ago

Olha eu aqui outra vez 😂

Acredito que uma forma super prática, seja criar uma abstração de API. Dessa forma, independente do que a API retorne, a abstração deixa tudo no seu padrão (em inglês, por exemplo) e o projeto passa a chamar os resultados da API a partir dessa abstração ao invés da API de fato.

@Victoreisdavid, você poderia adicionar a label good first contribution/issue e fixar esse Issue no projeto. Assim, todo mundo que entrar na aba Issues vai ver, aumentando a change de uma contribuição 🚀


Só uma observação, tudo que passei aqui são só sugestões 🩵

wellwelwel commented 1 year ago

Um exemplo bem simples de como isso seria na prática, onde supostamente uma API de CEP retorne as propriedades em português:

export const API = {
  street: ORIGINAL_API.rua,
  neighborhood: ORIGINAL_API.bairro,
  // ...
}

Dessa forma, quando você for utilizar os dados, basta chamar pela sua API:

import { API } from './api.js';

console.log(
  API.street,
  API.neighborhood,
);
Victoreisdavid commented 1 year ago

Olha eu aqui outra vez 😂

Acredito que uma forma super prática, seja criar uma abstração de API. Dessa forma, independente do que a API retorne, a abstração deixa tudo no seu padrão (em inglês, por exemplo) e o projeto passa a chamar os resultados da API a partir dessa abstração ao invés da API de fato.

@Victoreisdavid, você poderia adicionar a label good first contribution e fixar esse Issue no projeto. Assim, todo mundo que entrar na aba Issues vai ver, aumentando a change de uma contribuição 🚀

Só uma observação, tudo que passei aqui são só sugestões 🩵

Olá Well! Seja bem vindo!

Abstração de API parece ser uma boa ideia, tenho em mente algumas mudanças para fazer no projeto, uma delas inclui manter meu próprio banco de dados atualizado periodicamente, porque o Dados Abertos sempre tá com problemas de estabilidade. Dessa forma, o funcionamento do FiscalizaJa independe da disponibilidade do Dados Abertos.

Farei com certeza algo assim, se não vai dificultar a manutenção do código no futuro.