Skip to content

Feat/good practices#565

Open
RodriAndreotti wants to merge 7 commits intoBrasilAPI:mainfrom
RodriAndreotti:feat/good_practices
Open

Feat/good practices#565
RodriAndreotti wants to merge 7 commits intoBrasilAPI:mainfrom
RodriAndreotti:feat/good_practices

Conversation

@RodriAndreotti
Copy link
Copy Markdown
Collaborator

Cria um guia básico de boas práticas para direcionar novos desenvolvimentos.
Alguns dos pontos discutidos na PR #256 e posteriormente levados para a Issue #262.

Opiniões, correções e sugestões, fiquem a vontade.

Reabertura em novo pr em branch específica, anterior fechado devido a atualização da branch:

Histórico completo em: #268

Alteração na recomendação de idioma dos endpoints de inglês para português do Brasil
@vercel
Copy link
Copy Markdown

vercel bot commented Dec 4, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
brasilapi ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 15, 2025 11:05am

@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Dec 4, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

LorhanSohaky
LorhanSohaky previously approved these changes Jan 4, 2024
@sonarqubecloud
Copy link
Copy Markdown

@sonarqubecloud
Copy link
Copy Markdown

Comment thread GOOD_PRACTICES.md Outdated
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Jan 7, 2025

@sonarqubecloud
Copy link
Copy Markdown

@lucianopf
Copy link
Copy Markdown
Member

Olá @RodriAndreotti, obrigado pela contribuição! O guia de boas práticas é muito útil para padronizar contribuições futuras.

Algumas correções antes de mesclar:

Problemas que precisam ser corrigidos:

  1. PascalCase para métodos/funções está incorreto para JavaScript — em JS, a convenção é camelCase para funções e métodos, e PascalCase apenas para classes/construtores. A linha atual diz "Nomes de Classe, métodos e funções deveriam utilizar o padrão PascalCase" — isso induziria contribuidores a usar PascalCase para funções (ex: GetUserData()), o que não é idiomático em JS. Correção sugerida: separar em duas linhas — "Nomes de classes deveriam usar PascalCase" e "Nomes de funções e métodos deveriam usar camelCase".

  2. Inconsistência no exemplo de moeda — o guia diz que propriedades de retorno devem usar snake_case, mas o exemplo usa isoCode (camelCase). Deveria ser iso_code.

  3. Typonomemclaturanomenclatura

As atualizações no CONTRIBUTING.md (master → main, link para o guia) estão ótimas. Com as correções acima o PR está pronto para merge.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants