Beagandica/Add Workshop Standards & Checklist for Contributors#597
Closed
beagandica wants to merge 3 commits into
Closed
Beagandica/Add Workshop Standards & Checklist for Contributors#597beagandica wants to merge 3 commits into
beagandica wants to merge 3 commits into
Conversation
Establishes clear guidelines for creating and reviewing workshops based on analysis of our most successful workshops (web-basics, python-turtle, earsketch). Includes: - Required file structure and frontmatter templates - New workshop checklist (landing page, activities, answer key, conclusion) - PR review checklist for reviewers - Writing and language guidelines - Hugo shortcode reference - Translation guidelines - Step-by-step guide for creating new workshops - Links to gold-standard workshops as examples Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Remove conclusion.md as required file (Hugo theme auto-adds Nuvi 'You did it! Workshop complete' to last page of every workshop) - Replace 'frontmatter' with 'metadata block' and add explanation that it refers to the YAML between --- markers (Hugo front matter) - Update PR review checklist and step-by-step guide accordingly Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
beagandica
pushed a commit
to beagandica/workshops
that referenced
this pull request
Apr 27, 2026
Merge comprehensive workshop creation guidance from WORKSHOP-STANDARDS.md (PR NuevoFoundation#597) into the /guidelines/ pages so they are the one-stop shop for contributors. PR NuevoFoundation#597 can now be closed. new-workshops.md rewritten from 3-line stub to comprehensive guide: - Workshop philosophy (story-driven, personalizable, self-paced, progressive) - Gold standard examples (web-basics, python-turtle, earsketch) - Scaffold script workflow (integrated from PR NuevoFoundation#634) - Comprehensive quality checklist (36 items across 6 categories) - PR review checklist (10 items for reviewers) - Cross-links to all specialist guideline pages Also updated: - images-and-gifs.md: standardized on media/ convention (scaffold default), added backward-compat note for older workshops using img/, fixed shortcode delimiter consistency - translation-volunteer.md: added Spanish tu-conjugation note - _index.md: aligned all link texts with target page titles (sentence case) 10-model QA + 3 clean convergence passes. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Member
Author
|
Closing this PR — all of its content has been folded into the /guidelines/ pages in PR #636:
The goal was to make /guidelines/\ the one-stop shop so contributors don't need a separate WORKSHOP-STANDARDS.md file. The comprehensive |
beagandica
pushed a commit
to beagandica/workshops
that referenced
this pull request
Apr 29, 2026
Merge comprehensive workshop creation guidance from WORKSHOP-STANDARDS.md (PR NuevoFoundation#597) into the /guidelines/ pages so they are the one-stop shop for contributors. PR NuevoFoundation#597 can now be closed. new-workshops.md rewritten from 3-line stub to comprehensive guide: - Workshop philosophy (story-driven, personalizable, self-paced, progressive) - Gold standard examples (web-basics, python-turtle, earsketch) - Scaffold script workflow (integrated from PR NuevoFoundation#634) - Comprehensive quality checklist (36 items across 6 categories) - PR review checklist (10 items for reviewers) - Cross-links to all specialist guideline pages Also updated: - images-and-gifs.md: standardized on media/ convention (scaffold default), added backward-compat note for older workshops using img/, fixed shortcode delimiter consistency - translation-volunteer.md: added Spanish tu-conjugation note - _index.md: aligned all link texts with target page titles (sentence case) 10-model QA + 3 clean convergence passes. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
ozhang22
pushed a commit
that referenced
this pull request
May 6, 2026
…13) (#636) * Add 5 missing guidelines pages (Closes #7, #10, #11, #12, #13) New content pages for the contributor guidelines section: - Translation volunteer guide (Closes #7) - Images and GIFs (Closes #10) - Navigation (Closes #11) - Code and interactivity (Closes #12) - Tags and metadata (Closes #13) Updated _index.md to link all new pages and add a Translators section. These issues have been open since July 2019. The content is based on patterns established across 42 workshops and our NF QA standard. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix QA findings: .NET Fiddle naming, CodePen pattern, Replit note, cross-refs - Rename 'DotNetFiddle' to '.NET Fiddle' in prose (matching repo convention) - Replace CodePen iframe embed with actual repo pattern (button link) - Add note about replit.com vs old repl.it domain - Note that raw HTML works without rawhtml shortcode (unsafe=true enabled) - Add see-also cross-references to related guideline pages Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix QA pass 2 findings: icon table, details HTML, figure claim, Replit, notices - H1: Remove broken icon shortcodes from table (theme incompatible), use text-only - M1: Fix <details close> to <details> (valid HTML for collapsed state) - M2: Remove 'preferred approach' claim for figure shortcode - M3: Remove deprecated ?lite=true from Replit embed example - M4: Use generic issue link (template PR not yet merged) - M5: Fix notice shortcode delimiter from < > to % % Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fold PR #597 workshop standards into guidelines pages Merge comprehensive workshop creation guidance from WORKSHOP-STANDARDS.md (PR #597) into the /guidelines/ pages so they are the one-stop shop for contributors. PR #597 can now be closed. new-workshops.md rewritten from 3-line stub to comprehensive guide: - Workshop philosophy (story-driven, personalizable, self-paced, progressive) - Gold standard examples (web-basics, python-turtle, earsketch) - Scaffold script workflow (integrated from PR #634) - Comprehensive quality checklist (36 items across 6 categories) - PR review checklist (10 items for reviewers) - Cross-links to all specialist guideline pages Also updated: - images-and-gifs.md: standardized on media/ convention (scaffold default), added backward-compat note for older workshops using img/, fixed shortcode delimiter consistency - translation-volunteer.md: added Spanish tu-conjugation note - _index.md: aligned all link texts with target page titles (sentence case) 10-model QA + 3 clean convergence passes. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Beatris Mendez Gandica <bemendez@microsoft.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this adds
A
WORKSHOP-STANDARDS.mdguide for contributors, interns, and reviewers to follow when creating or reviewing workshops.Based on analysis of our most successful workshops
Includes
Key decisions documented
hidden: truein metadataWhy now
We have 2 volunteer interns joining soon and want clear expectations for workshop quality. This also gives reviewers a checklist to use during PR reviews.
@ozhang22 for review