search

skills / release-based-workflow

Create a release based workflow that is built on the foundations of the GitHub flow
MIT License
119 stars 63 forks source link

[Feature] Story about why changes are made is unclear, where is the bug? #54

Open gitgithan opened 1 year ago

gitgithan commented 1 year ago

On step 1 readme, we have Introduce a bug to be fixed later It seems updating game text color to green is the bug as shown in 

## Description:
- Updated game text color to green

Later in step 6 readme I made a mistake and introduced a bug. Instead of changing the text colors to green, we changed the whole game background.. This is confusing. Is updating game text color to green desired or not? It's a bug in step 1, then became the desired outcome in step 6?

Assuming there is indeed a bug introduced in step 1, where is the fix? It seems the fix is already done in .github/changes for the learner. If the learner is not supposed to do the bug fixing, why is the learner even introducing bugs by manipulating files in earlier steps when .github/changes already contains game-with-bug.js and game-fixed.js?

General feedback to improve all skill courses

  1. Screenshot an end state of Network Graph so learners can monitor whether they are working on correct branches image
  2. Add a list of common mistakes to help learners self help issues like steps not triggering
    • Working on wrong branch
    • Changed wrong file
  3. A meta course on how to go through Github Skills in video format would help learners get the most of of it.
    • How to monitor actions tab, what the UI means? (eg. branches shown, multiple workflow files can run for 1 commit, release triggers are not associated with any branch)
    • How to observe network graph
    • Explaining how the Update Step action adds commits to every branch

If I never developed the above introspection skills, I would've just clicked through the skills and gotten way less understanding out of them.