代码修订实践博阿斯

2025-05-25

代码修订实践博阿斯

对代码的修订是对代码质量的极端重要的行动。最终的结果 技术经理拉取请求修订。请参阅有关如何修改所有环境的实用程序。我是不是觉得很无聊? :)

索引

1. 请求拉取请求

为了方便您的生活,重要的是要定义一个 Pull Request 的详细信息,您可以通过详细描述和图像进行超级描述,“Alteração realizada。Valeu,tamo junto”。

如何配置

Para fazer isso, basta criar no seu projeto uma Pasta chamada .github and dentro dela criar um arquivo pull_request_template.md

Ps:请注意,我的模板是一个组织,可以从 com 或 nome .github 或 arquivo pull_request_template.md 获取。

如果没有pull_request_template,则可以将其espera receber模型escreve,então semper que alguém abrir uma PR,aparecerá o modelo para preencher:

Imagem de uma pull request sendo criada 图像

O que adicionar em um 模板

工作人员可以帮助您完成任务,也可以轻松修改您的生活,并快速修改您的内容。

Algumas sugestões do que adicionar em um 模板:

  • PR 的类型是什么?
  • 运动表现说明
  • 附加图像或 GIF 效果
  • Origem da alteração:票证、对话无懈怠、任务无 ji​​ra?德克萨 o 链接!
  • 睾丸
  • 文献
  • Ações para realizar após aprovação: como executar uma query no banco, realizar alguma configuração ou algo do gênero
  • Deixar claro quais Campos são obrigatórios 和 quais são opcionais

模板示例

Para definir o modelo, o melhor é alinhar com o time and chegar a um acordo que faça sentido para todos. Mas vou deixar aqui alguns modelos que já testei:

简单且直接:

## Descrição breve da PR: (obrigatório)

## Exemplos de como testar a PR: (obrigatório)

## Imagens anexas: (opcional)
Enter fullscreen mode Exit fullscreen mode

更多详情:

## Tipo de alteração: 
[ ] Nova funcionalidade
[ ] Correção de bug
[ ] Teste
[ ] CI/CD
[ ] Documentação

## Motivo da alteração:

## Origem da solicitação:

## A alteração foi testada?

## Evidência de teste realizado:
Enter fullscreen mode Exit fullscreen mode

如果您想完成项目和时间的成熟,请提供一些必要或不需要的信息。 Além de que é algo que pode ser testado and ajustado de acordo com a experience of time com o modelo definido.

2. Empodere-se com ferramentas

在 adiantar 或 trabalho 上,使用超级工具并集成到 git 中。 Assim elas vão trabalhar semper que uma PR for aberta.

Qualidade

存在代码气味、漏洞和错误等问题。

声纳 没有声纳可以定义您的资格或最大允许资格类别。如果可以更改超通的定义,则可以将其合并到一起。
由 Ferramenta Sonar 打印

这是 VS Code 的集成,可在开发过程中保持警惕。

气候代码代码 气候是存在的,并且不符合项目的质量标准。 Na PR eleacrecenta sugestões de alteração。
打印气候代码

Sentry O Sentry可以帮助您检测生产过程中发生的错误并进行改进。例如,Sentry 的生产可能会影响其功能。
Sentry 铁打印

睾丸

Quando você tem sua cobertura de testes integradas no CI/CD, é válido deixar isso visível na PR.您可以通过声纳进行整合或使用JenkinsGithub Actions来自动执行操作:
打印 Github barrando testes

预览

方便您通过预览链接来测试和更改现实。如果您想在视觉效果或测试方面进行测试,那么后端没有任何变化:您可以通过自动分配自动 PR 链接 来更改可视化环境从而实现 CI/CD 的自动处理。
用 Vercel 铁打印

3. Não aprove por aprovar。修改com资格

好的,我们要修改一下吗? Deixo aqui algumas 建议:

  • Deixou algum commentário ou console.log sem querer?
  • 语法错误
  • Erro ortográfico (Erro de português para o cliente nãoo)
  • 记住或记住代码吗?
  • 是否可以改变描述的方式?
  • 解决问题的其他方法是什么?
  • 是否对功能的处理过程产生了影响?

请参阅实际验证列表。 E claro, Quanto mais avançado e estruturado o padrão de qualidade do seu time, menos você tem que se preocupar em revisar mais básicas como sintaxe and cada vez você vai poder focar solução é válida para a regra de negócio.

项目和设备启动,并可快速验证并自动启动/扫描。这一切都是一项不断升级的装备,也是一项严谨的修订。

4. 建设性反馈

修订过程是法律法规和功能的重要组成部分,是教育管理和长期反馈建设的重要组成部分。 Não é nada pessoal, apenas focado em manter a qualidade na escrita do projeto.

考虑因素

如果出现错误,请在没有任何可能的情况下进行应用。如果您想听一些伟大的歌曲,您可以通过以下方式进行解释性评论:您可以通过以下方式进行更改。

在修改过程中,更改功能、影响或修改过程是非常重要的。

我不想解决这个问题。如果需要修改所有必要的标准,则无需征求变更意见。

例子

修订有关如何改进的方法的示例: 如果要修改其他方法,请使用以下方法来修改错误的部分以及更改后的结果。 Isso evitaria um alinhamento extra no slack e mais um commit extra com o ajuste Final。 O que pode parecer pouco, mas com muitas PRs para revisar, no Final do dia issodemanda um bom tempo dedicado.
公关修订的建议示例

第二个例子是改变改变动机的建议:
公关修订建议示例

Como revisor não somos donos da verdade,então é importante em casos de dúvida alinhar com a pessoa or que ela levou em thinkação para chegar naquela solução. E claro、semper coletar 反馈和进化过程。

结论

修订过程涉及项目方向的变化以及与谈判相关技术的重要结合。

Boas práticas podem ser Implementadas desde times pequenos, para criar uma cultura de revisão e troca de conhecimento entre as pessoas.

为了确保我们的产品功能和客户的真实性,我们将采取灵活的操作和检测器详细信息,以确保我们的产品功能和客户满意度。

最终的图像是符合条件的:

代码修订版

Deixa um Feedback se utiliza alguma dessas técnicas no seu dia a dia ou se tem mais alguma boa prática que eu deveria aplicar!

文章来源:https://dev.to/lorenalgm/boas-praticas-para-revisao-de-codigo-20la
PREV
如何像专业人士一样制作 HTML 表单 这是 html5 中所有输入类型的列表!
NEXT
打造你的开发者身份:2024 年蓝图🌟