Skip to content

Conversation

cifarquhar
Copy link

What does this change?

This incorporates the contents of the Developer-Specs repo into curriculum, and makes some changes to the content of the workshop.

In this repo:

  • Adds the workshop to common-content/blocks/developer-specs
  • Updates ITP Onboarding Sprint 1's day plan to reference this instead of the old repo.

In the workshop:

  • Directs the trainees to a separate repo to complete the exercises
  • Re-orders learning objectives to match the order of exercises
  • Removes some text which is now redundant

Common Content?

  • Block/s

Common Theme?

  • Yes

Issue number: N/A

Org Content?

Sprint | Block

Checklist

Who needs to know about this?

Copy link

netlify bot commented Oct 3, 2025

Deploy Preview for cyf-common ready!

Name Link
🔨 Latest commit bbbd9e7
🔍 Latest deploy log https://app.netlify.com/projects/cyf-common/deploys/68df968e1795130008ea6e83
😎 Deploy Preview https://deploy-preview-1605--cyf-common.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link

netlify bot commented Oct 3, 2025

Deploy Preview for cyf-curriculum ready!

Name Link
🔨 Latest commit bbbd9e7
🔍 Latest deploy log https://app.netlify.com/projects/cyf-curriculum/deploys/68df968e2ba4e40008468083
😎 Deploy Preview https://deploy-preview-1605--cyf-curriculum.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 85 (no change from production)
Accessibility: 100 (no change from production)
Best Practices: 92 (no change from production)
SEO: 100 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link

netlify bot commented Oct 3, 2025

Deploy Preview for cyf-programming ready!

Name Link
🔨 Latest commit bbbd9e7
🔍 Latest deploy log https://app.netlify.com/projects/cyf-programming/deploys/68df968ebb5f3300089b78c7
😎 Deploy Preview https://deploy-preview-1605--cyf-programming.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 77 (🔴 down 14 from production)
Accessibility: 100 (no change from production)
Best Practices: 92 (no change from production)
SEO: 90 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link

netlify bot commented Oct 3, 2025

Deploy Preview for cyf-piscine ready!

Name Link
🔨 Latest commit bbbd9e7
🔍 Latest deploy log https://app.netlify.com/projects/cyf-piscine/deploys/68df968e0b74450008402c46
😎 Deploy Preview https://deploy-preview-1605--cyf-piscine.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 85 (🔴 down 2 from production)
Accessibility: 100 (no change from production)
Best Practices: 92 (no change from production)
SEO: 100 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link

netlify bot commented Oct 3, 2025

Deploy Preview for cyf-sdc ready!

Name Link
🔨 Latest commit bbbd9e7
🔍 Latest deploy log https://app.netlify.com/projects/cyf-sdc/deploys/68df968e3e3eff0008c185be
😎 Deploy Preview https://deploy-preview-1605--cyf-sdc.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link

netlify bot commented Oct 3, 2025

Deploy Preview for cyf-tracks ready!

Name Link
🔨 Latest commit bbbd9e7
🔍 Latest deploy log https://app.netlify.com/projects/cyf-tracks/deploys/68df968e7f19d60007606238
😎 Deploy Preview https://deploy-preview-1605--cyf-tracks.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link

netlify bot commented Oct 3, 2025

Deploy Preview for cyf-launch ready!

Name Link
🔨 Latest commit bbbd9e7
🔍 Latest deploy log https://app.netlify.com/projects/cyf-launch/deploys/68df968e340e6c0008d28fb8
😎 Deploy Preview https://deploy-preview-1605--cyf-launch.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link

netlify bot commented Oct 3, 2025

Deploy Preview for cyf-itd ready!

Name Link
🔨 Latest commit bbbd9e7
🔍 Latest deploy log https://app.netlify.com/projects/cyf-itd/deploys/68df968e0b65710008cd6138
😎 Deploy Preview https://deploy-preview-1605--cyf-itd.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 86 (🟢 up 12 from production)
Accessibility: 100 (no change from production)
Best Practices: 92 (no change from production)
SEO: 100 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Member

@illicitonion illicitonion left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is all looking great, thanks!

One question - do you want the trainees to have permission to add labels? They should all be in a GitHub team because they should have completed CodeYourFuture/Module-Welcome#2 the sprint before (and long-term, we want to automate that). I ask because I've seen value both ways - I've seen value in them not being able to add labels (because it prompts an interesting discussion of permissions / ownership) but if so we maybe want to hint at it in the workshop. And I've seen value in them being able to add labels (it's good practice!) but if so we should add "ITP Trainees" as either "Triage" or "Request Code Review" access in https://github.com/CodeYourFuture/github_issues_prs_practice/settings/access

There are three activities. Split into groups of no more than 5 and set a timer so you don't lose track of time.


> [!NOTE]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We're in a bit of a transitionary state with note-shaped things...

We have our own custom tag for this: {{<note type="exercise">}} where we can attach different titles and emoji to the title of the note.

GitHub recently added [!NOTE] and a few other directives, but they don't allow any customisation of the title. This styles exactly the same as a {{<note>}} without a type. We generally use the GitHub ones ([!NOTE], [!WARNING], etc) when we want exactly that heading, and our own when we want a different one.

I'd suggest here we want to do one of three things:

  1. Switch to a {{<note type="exercise">}} so we get an "exercise" heading instead of a "Note" one.
  2. Switch to a {{<note type="exercise" title="Exercise 1: Eat Me, Drink Me 📚 (10 minutes)">}} and drop the ## title, so the title appears as a naturally styled title in the block.
  3. Make {{<note>}} without a type attribute just do the box-styling without adding a title, and leave the ## title as-is.

I think I have a preference for 2 or 3, because I don't think the duplicate "exercise" title and "Exercise 1: ..." title are valuable

Popcorn round your group and share one key takeaway

> [!NOTE]
> ## Exercise 3: Pull the Other One 🕵️ (20 minutes)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When I've run this workshop in the past, people have generally gotten confused by this heading and asked about :)

Suggested change
> ## Exercise 3: Pull the Other One 🕵️ (20 minutes)
> ## Exercise 3: Pull Requests 🕵️ (20 minutes)


Write your key takeaway down in your notebook.

## Solo Challenge: Hidden Powers 🔮 (5 minutes)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be styled as an exercise?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's rename this directory to using-github-workshop or similar?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 📋 Backlog
Development

Successfully merging this pull request may close these issues.

2 participants