草庐IT

创建剧本以开始新的编码任务

技术的游戏 2023-10-08 原文

您在平台竞标中中标了，或者，您已收到客户的要求。

你做的第一件事是什么？

有一本剧本很有价值。每次开始研究代码中的新更改时都要遵循的过程。

它使您的工作更可预测、更完整和更正确。你会成为更好的开发者。

需要发生什么

让我们以平台中标中的项目为例。这是最简单的。

需要发生什么？

  • 编写实现该功能的代码
  • 为该功能代码编写测试
  • 确保所有测试通过
  • 打开拉取请求
  • （通常）通过代码审查
  • 通过 UI 测试和 QA
  • 成功部署到所有环境

好多啊！这不仅仅是“编写代码”的步骤。

您的操作手册

每个人对如何构建剧本的偏好都会略有不同。但重要的是你有一个。

所有这些步骤都不会像预期的那样落到实处！他们采取计划和习惯来执行。

这是我开始一项新任务时所做的。也许它会对你有所帮助。

  1. 我开始一个新的 git 分支。这通常是我的第一步。
  2. 我找到了需要更改的代码部分，但我还没有进行更改。这可能需要一段时间，因为代码可能有多层，我可能需要在多个地方进行更改。
  3. 我为我将要更改的功能寻找任何现有测试。如果我幸运的话，已经有很好的测试了！如果我没有，我会编写测试来帮助我确信我没有破坏任何东西。我还通过首先测试代码更好地理解了代码。
  4. 现在，我准备好做出尽可能小的改变。不要让拉取请求的范围扩大。专注于你的任务和需要发生的事情。
  5. 当然，我也为我的新代码编写测试。有时我练习 TDD。其他时候，我对何时以及编写什么测试更加宽松。
  6. 我在开发时经常运行单元测试。它们是我告诉自己过得如何的第一工具。好的编码是反馈的问题。单元测试提供最紧密的反馈循环之一。
  7. 一旦单元测试通过，我就会将更改推送到 GitHub。我打开了一个拉取请求草案，这样其他人就不会自动分配审查了。我让我们的 GitHub 自动化负责运行完整的测试套件。
  8. 在完整套件运行的同时，我给自己进行了一次代码审查。令人惊奇的是，当我在 GitHub 中审查自己的代码作为差异时，我看到了多少小错误或优化机会。在我请求审查之前，我希望我的代码尽可能小和干净。
  9. 如果所有测试都通过，我会请求审查以从我的团队那里获得反馈。
  10. 当我准备好部署时，我让我们的 CI/CD 管道处理细节。但我立即对这些变化进行现场排查测试，因为它正在通过环境。

常识

本操作手册可能看起来像是常识。

当然你需要测试你的代码！当然，您应该保持代码更改干净且小！

不幸的是，常识并不那么普遍。通过为自己创建一个明确的运行手册，我不会让常识成为偶然。

每次进行更改时，我都遵循相同的步骤。

每日清单

我每天早上都会为软件开发人员写一些新东西。

如果你喜欢我的文章，点赞，关注，转发！

剧本创建li编写的

有关创建剧本以开始新的编码任务的更多相关文章

  1. ruby - 其他文件中的 Rake 任务 - 2

    我试图在一个项目中使用rake，如果我把所有东西都放到Rakefile中，它会很大并且很难读取/找到东西，所以我试着将每个命名空间放在lib/rake中它自己的文件中，我添加了这个到我的rake文件的顶部:Dir['#{File.dirname(__FILE__)}/lib/rake/*.rake'].map{|f|requiref}它加载文件没问题，但没有任务。我现在只有一个.rake文件作为测试，名为“servers.rake”，它看起来像这样:namespace:serverdotask:testdoputs"test"endend所以当我运行rakeserver:testid时

  2. ruby - 如何在 Ruby 中顺序创建 PI - 2

    出于纯粹的兴趣，我很好奇如何按顺序创建PI，而不是在过程结果之后生成数字，而是让数字在过程本身生成时显示。如果是这种情况，那么数字可以自行产生，我可以对以前看到的数字实现垃圾收集，从而创建一个无限系列。结果只是在Pi系列之后每秒生成一个数字。这是我通过互联网筛选的结果:这是流行的计算机友好算法，类机器算法:defarccot(x,unity)xpow=unity/xn=1sign=1sum=0loopdoterm=xpow/nbreakifterm==0sum+=sign*(xpow/n)xpow/=x*xn+=2sign=-signendsumenddefcalc_pi(digits

  3. python - 如何使用 Ruby 或 Python 创建一系列高音调和低音调的蜂鸣声？ - 2

    关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题？更新问题，以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我想在固定时间创建一系列低音和高音调的哔哔声。例如:在150毫秒时发出高音调的蜂鸣声在151毫秒时发出低音调的蜂鸣声200毫秒时发出低音调的蜂鸣声250毫秒的高音调蜂鸣声有没有办法在Ruby或Python中做到这一点？我真的不在乎输出编码是什么(.wav、.mp3、.ogg等等)，但我确实想创建一个输出文件。

  4. ruby - 什么是填充的 Base64 编码字符串以及如何在 ruby​​ 中生成它们？ - 2

    我正在使用的第三方API的文档状态:"[O]urAPIonlyacceptspaddedBase64encodedstrings."什么是“填充的Base64编码字符串”以及如何在Ruby中生成它们。下面的代码是我第一次尝试创建转换为Base64的JSON格式数据。xa=Base64.encode64(a.to_json) 最佳答案 他们说的padding其实就是Base64本身的一部分。它是末尾的“=”和“==”。Base64将3个字节的数据包编码为4个编码字符。所以如果你的输入数据有长度n和n%3=1=>"=="末尾用于填充n%

  5. ruby - 使用 Vim Rails，您可以创建一个新的迁移文件并一次性打开它吗？ - 2

    使用带有Rails插件的vim，您可以创建一个迁移文件，然后一次性打开该文件吗？textmate也可以这样吗？ 最佳答案 你可以使用rails.vim然后做类似的事情::Rgeneratemigratonadd_foo_to_bar插件将打开迁移生成的文件，这正是您想要的。我不能代表textmate。 关于ruby-使用VimRails，您可以创建一个新的迁移文件并一次性打开它吗？，我们在StackOverflow上找到一个类似的问题： https://sta

  6. ruby - 用逗号、双引号和编码解析 csv - 2

    我正在使用ruby​​1.9解析以下带有MacRoman字符的csv文件#encoding:ISO-8859-1#csv_parse.csvName,main-dialogue"Marceu","Giveittohimóhe,hiswife."我做了以下解析。require'csv'input_string=File.read("../csv_parse.rb").force_encoding("ISO-8859-1").encode("UTF-8")#=>"Name,main-dialogue\r\n\"Marceu\",\"Giveittohim\x97he,hiswife.\"\

  7. ruby-on-rails - 无法使用 Rails 3.2 创建插件？ - 2

    我对最新版本的Rails有疑问。我创建了一个新应用程序(railsnewMyProject)，但我没有脚本/生成，只有脚本/rails，当我输入ruby./script/railsgeneratepluginmy_plugin"Couldnotfindgeneratorplugin.".你知道如何生成插件模板吗？没有这个命令可以创建插件吗？PS:我正在使用Rails3.2.1和ruby​​1.8.7[universal-darwin11.0] 最佳答案 随着Rails3.2.0的发布，插件生成器已经被移除。查看变更日志here.现在

  8. ruby - 如何使用 RSpec::Core::RakeTask 创建 RSpec Rake 任务？ - 2

    如何使用RSpec::Core::RakeTask初始化RSpecRake任务？require'rspec/core/rake_task'RSpec::Core::RakeTask.newdo|t|#whatdoIputinhere?endInitialize函数记录在http://rubydoc.info/github/rspec/rspec-core/RSpec/Core/RakeTask#initialize-instance_method没有很好的记录；它只是说:-(RakeTask)initialize(*args,&task_block)AnewinstanceofRake

  9. ruby - 为什么 SecureRandom.uuid 创建一个唯一的字符串？ - 2

    关闭。这个问题需要detailsorclarity.它目前不接受答案。想改进这个问题吗？通过editingthispost添加细节并澄清问题.关闭8年前。Improvethisquestion为什么SecureRandom.uuid创建一个唯一的字符串？SecureRandom.uuid#=>"35cb4e30-54e1-49f9-b5ce-4134799eb2c0"SecureRandom.uuid方法创建的字符串从不重复？

  10. ruby - 有人可以帮助解释类创建的 post_initialize 回调吗 (Sandi Metz) - 2

    我正在阅读SandiMetz的POODR，并且遇到了一个我不太了解的编码原则。这是代码:classBicycleattr_reader:size,:chain,:tire_sizedefinitialize(args={})@size=args[:size]||1@chain=args[:chain]||2@tire_size=args[:tire_size]||3post_initialize(args)endendclassMountainBike此代码将为其各自的属性输出1,2,3,4,5。我不明白的是查找方法。当一辆山地自行车被实例化时，因为它没有自己的initialize方法

随机推荐