Stateless Code | Fix a Documentation Bug Referring to the Wrong Project @StatelessCode | Uploaded March 2023 | Updated October 2024, 6 hours ago.
In our other series for the NerdDice RubyGem, we were attempting to adapt the CONTRIBUTING.md file from this project and discovered that the file from NerdDice.com was already referring to the issues list for the RubyGem project instead of the Rails Project. We added an item to the backlog of this project in that video. In this video, we take care of it.
We use the project-level search and replace in Visual Studio Code to replace the instances of the other project name followed by a slash with the correct project name. (We do replace with a typo at first and then need to do a second replace to fix it.)
After pushing the code to the repo, we test it to make sure that the links in the CONTRIBUTING and README files are pointing to the issues log for the correct project.
This video covers:
00:00:12 Introduction
00:01:24 Demonstrate the problem
00:02:18 Use search and replace at the project level to find "nerd_dice/" (replaced with typo)
00:04:34 Detect and fix the typo with a second search and replace
00:05:31 Review the git diff to ensure the correct changes
00:06:21 Add, commit, and push the code. Open a pull request.
00:07:17 Test that the changed links navigate to the correct location
00:10:00 Merge the pull request and finish up
#ruby #rails7 #rails #rubyonrails #rubygems #codecast #screencast #github #opensource #minitest #TDD #agile #NerdDice #DnD #roleplaying #softwaredevelopment #learntocode #documentation #bugfix #readme #markdown #githubmarkdown #vscode
See other related StatelessCode videos:
- Add a CONTRIBUTING.md File to the Project to Help with Collaboration youtu.be/BI7zcbbPREk
- Create a RubyGem 92: Add Contributing Guidelines to the Project youtu.be/IiUWiV2svIU
This video is CC0 - No rights reserved. (YouTube doesn't allow this option when publishing.) All code is released under the UNLICENSE. Stateless Code denies the concept of "intellectual property". Copying is not stealing.
In our other series for the NerdDice RubyGem, we were attempting to adapt the CONTRIBUTING.md file from this project and discovered that the file from NerdDice.com was already referring to the issues list for the RubyGem project instead of the Rails Project. We added an item to the backlog of this project in that video. In this video, we take care of it.
We use the project-level search and replace in Visual Studio Code to replace the instances of the other project name followed by a slash with the correct project name. (We do replace with a typo at first and then need to do a second replace to fix it.)
After pushing the code to the repo, we test it to make sure that the links in the CONTRIBUTING and README files are pointing to the issues log for the correct project.
This video covers:
00:00:12 Introduction
00:01:24 Demonstrate the problem
00:02:18 Use search and replace at the project level to find "nerd_dice/" (replaced with typo)
00:04:34 Detect and fix the typo with a second search and replace
00:05:31 Review the git diff to ensure the correct changes
00:06:21 Add, commit, and push the code. Open a pull request.
00:07:17 Test that the changed links navigate to the correct location
00:10:00 Merge the pull request and finish up
#ruby #rails7 #rails #rubyonrails #rubygems #codecast #screencast #github #opensource #minitest #TDD #agile #NerdDice #DnD #roleplaying #softwaredevelopment #learntocode #documentation #bugfix #readme #markdown #githubmarkdown #vscode
See other related StatelessCode videos:
- Add a CONTRIBUTING.md File to the Project to Help with Collaboration youtu.be/BI7zcbbPREk
- Create a RubyGem 92: Add Contributing Guidelines to the Project youtu.be/IiUWiV2svIU
This video is CC0 - No rights reserved. (YouTube doesn't allow this option when publishing.) All code is released under the UNLICENSE. Stateless Code denies the concept of "intellectual property". Copying is not stealing.
