From fbeeedaad07b569e47c34b584a1e364dc32d9cc3 Mon Sep 17 00:00:00 2001 From: John Chriest Date: Sat, 2 Sep 2023 03:28:26 -0700 Subject: [PATCH] Feature: Add screencast link to README to giving overview for contributors (#4090) ## Because This PR adds an interactive screencast to the README that gives a general overview of the contributing guide to new collaborators. It helps people who may be new to contributing to this or any other repo get a sense of the code base and how to get it running locally. I used a new Scrimba feature that lets one make a video screencast with all the assets of a github repo. ## This PR - Added link to interactive screencast (scrim) to __README__ in the __Contributing__ section ## Issue Related to #3470 ## Additional Information Here is a link to the screencast (scrim): https://scrimba.com/scrim/cEggQncE I can also turn this into an image that links to the scrim video instead of text if you prefer that. ## Pull Request Requirements - [x] I have thoroughly read and understand [The Odin Project Contributing Guide](https://github.com/TheOdinProject/theodinproject/blob/main/CONTRIBUTING.md) - [x] The title of this PR follows the `keyword: brief description of change` format, using one of the following keywords: - `Feature` - adds new or amends existing user-facing behavior - `Chore` - changes that have no user-facing value, refactors, dependency bumps, etc - `Fix` - bug fixes - [x] The `Because` section summarizes the reason for this PR - [x] The `This PR` section has a bullet point list describing the changes in this PR - [ ] I have verified all tests and linters pass after making these changes. - [x] If this PR addresses an open issue, it is linked in the `Issue` section - [ ] If applicable, this PR includes new or updated automated tests --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 4c2a0e3fc1..9bb549c3f5 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,8 @@ Our community can be found on the [TOP Discord server](https://discord.gg/fbFCkY The Odin Project depends on open-source contributions to improve, grow, and thrive. We welcome contributors of all experience levels and backgrounds to help maintain this awesome curriculum and community. If you would like to contribute to our curriculum, be sure to thoroughly read our [contributing guide](https://github.com/TheOdinProject/theodinproject/blob/main/CONTRIBUTING.md). +__Feel free to also watch [this interactive screencast](https://scrimba.com/scrim/cEggQncE), which will give you an introduction to the repository.__ + ## Significant Contributors - [Erik Trautman](https://github.com/eriktrautman)