Uploaded January 2023 | Updated September 2026, 3 weeks ago
Continuing our momentum from the previous video where we wrote contributing guidelines, in this video we spend some time to take the generic README.md and flesh it out with information about our application.
Our README provides a summary of the project, links to the coding videos associated with the project, and instructions on how to set up and run the application locally.
Before we work on the README, we demonstrate that the links to other files in our repo on our feature branch version of CONTRIBUTING.md don't work because they are hard-coded to refer to the main branch and some of those files don't exist there. We solve this problem by using relative links instead. We amend the previous commit (neglecting to sign the amended commit), and force push to our branch.
After fixing the CONTRIBUTING file, we use the same method of writing the README in the GitHub MarkDown editor and then pasting it into Visual Studio Code.
We push to our branch and test out our links in the file. It's a good thing, because one of them used an underscore when it should have been a hyphen, producing a dead link.
We then amend the commit and force push to the branch again. We verify that the link is now fixed, open and merge the pull request, and discover that I neglected to sign both commits when amending them. Our main branch is protected, so we just decide to live with it.
This video covers:
00:00:12 Introduction
00:00:54 Fix links in CONTRIBUTING.md to be relative rather than targeted to main branch
00:04:00 Force push to the feature branch and demonstrate that the links work on the feature branch now
00:05:17 Write the draft of the updated README file
00:06:30 Review and demonstrate the draft of the README file
00:10:57 Modify the CONTRIBUTING.md Guidelines for etiquette section to refer to the README Conduct section instead of having the same exact text in both places
00:13:16 Review, commit, and push the changes
00:14:51 Review the README on the branch and test links
00:15:40 Fix typo of writing .ruby_version when it's supposed to be .ruby-version
00:19:38 Pull request, close issues, prune branches
00:22:29 Discover that I neglected to sign the commits when amending them
#ruby #rails7 #rails #rubyonrails #rubygems #codecast #screencast #github #opensource #minitest #TDD #agile #NerdDice #DnD #roleplaying #softwaredevelopment #learntocode #tailwind #postgresql #rubocop #devise #turbo #controllers #views #selenium #capybara #systemtest #readme #contributing #markdown
See other related StatelessCode videos:
- Add a CONTRIBUTING.md File to the Project to Help with Collaboration youtu.be/BI7zcbbPREk
- Codecast: Create a RubyGem 03: Set up RuboCop and flesh out the README youtu.be/Iz_Wl-IDL-c
- Codecast: Create a RubyGem 29: Add Build Badge to README youtu.be/DQqbYkMxhfU
- Codecast: Create a RubyGem 65: Fix README typos and Fix a Code Smell youtu.be/8yISBESH6vg
- Burn the Contributor Covenant with Fire! youtu.be/D9h572uwf8c
Resources that we relied upon for this solution:
- NerdDice Ruby Gem README github.com/statelesscode/nerd_dice/blob/dd89d66e0e14bc7ea4750c72c16bf58c8474ff7d/README.md
- Burn the Contributor Covenant with Fire Repository on GitHub github.com/msducheminjr/burn_the_contributor_covenant_with_fire
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.
Continuing our momentum from the previous video where we wrote contributing guidelines, in this video we spend some time to take the generic README.md and flesh it out with information about our application.
Our README provides a summary of the project, links to the coding videos associated with the project, and instructions on how to set up and run the application locally.
Before we work on the README, we demonstrate that the links to other files in our repo on our feature branch version of CONTRIBUTING.md don't work because they are hard-coded to refer to the main branch and some of those files don't exist there. We solve this problem by using relative links instead. We amend the previous commit (neglecting to sign the amended commit), and force push to our branch.
After fixing the CONTRIBUTING file, we use the same method of writing the README in the GitHub MarkDown editor and then pasting it into Visual Studio Code.
We push to our branch and test out our links in the file. It's a good thing, because one of them used an underscore when it should have been a hyphen, producing a dead link.
We then amend the commit and force push to the branch again. We verify that the link is now fixed, open and merge the pull request, and discover that I neglected to sign both commits when amending them. Our main branch is protected, so we just decide to live with it.
This video covers:
00:00:12 Introduction
00:00:54 Fix links in CONTRIBUTING.md to be relative rather than targeted to main branch
00:04:00 Force push to the feature branch and demonstrate that the links work on the feature branch now
00:05:17 Write the draft of the updated README file
00:06:30 Review and demonstrate the draft of the README file
00:10:57 Modify the CONTRIBUTING.md Guidelines for etiquette section to refer to the README Conduct section instead of having the same exact text in both places
00:13:16 Review, commit, and push the changes
00:14:51 Review the README on the branch and test links
00:15:40 Fix typo of writing .ruby_version when it's supposed to be .ruby-version
00:19:38 Pull request, close issues, prune branches
00:22:29 Discover that I neglected to sign the commits when amending them
#ruby #rails7 #rails #rubyonrails #rubygems #codecast #screencast #github #opensource #minitest #TDD #agile #NerdDice #DnD #roleplaying #softwaredevelopment #learntocode #tailwind #postgresql #rubocop #devise #turbo #controllers #views #selenium #capybara #systemtest #readme #contributing #markdown
See other related StatelessCode videos:
- Add a CONTRIBUTING.md File to the Project to Help with Collaboration youtu.be/BI7zcbbPREk
- Codecast: Create a RubyGem 03: Set up RuboCop and flesh out the README youtu.be/Iz_Wl-IDL-c
- Codecast: Create a RubyGem 29: Add Build Badge to README youtu.be/DQqbYkMxhfU
- Codecast: Create a RubyGem 65: Fix README typos and Fix a Code Smell youtu.be/8yISBESH6vg
- Burn the Contributor Covenant with Fire! youtu.be/D9h572uwf8c
Resources that we relied upon for this solution:
- NerdDice Ruby Gem README github.com/statelesscode/nerd_dice/blob/dd89d66e0e14bc7ea4750c72c16bf58c8474ff7d/README.md
- Burn the Contributor Covenant with Fire Repository on GitHub github.com/msducheminjr/burn_the_contributor_covenant_with_fire
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.
