Briana's notes

[brianamarie]

SUCH MAJOR SPARKLES to @a-a-ron and @JasonEtco for staying up so late and getting this live. I took a look at the commits and there are commits as recently as two hours ago...wow. This came so far in such a short period of time.

I was able to get through the first few steps before getting stuck. I can't tackle all of these things yet, because I need to focus on the Security course, but I will try to circle back if I can. Here are my notes:

Template repository

• [ ] The template repository is currently empty. What is the project that we want to help people build? Later in the course, there are two current actions where the bot opens pull requests. For that to work, there must be branches pre-existing. I've created branches and a template README.md, but do you want there to be distinct content on each branch? What is each PR activity trying to teach? https://github.com/githubtraining/introduction-to-github-apps/issues/18

README.md

• [x] Replace "Have you ever wanted to add your own feature to GitHub? Or to automate workflows to avoid repetitive tasks?" >> "Have you ever wanted to add your own feature to GitHub, or automate workflows to avoid repetitive tasks?"
• [x] Replace "APIs by being introduced to GitHub's REST and GraphQL APIs" >> "GitHub's REST and GraphQL APIs"
• [x] Replace "GitHub Apps-- what they are, their place in the development ecosystem, and how they're structured" >> "GitHub Apps -- what they are, their place in the development ecosystem, and how they're structured"

Config general

• [x] The name of the repository as its created for the user is "introduction to github apps template". Is that what we want?

Text general

• [x] Make sure headers match across course (and other courses)
• [x] Apps or apps? Is Apps a proper noun? Applications?
• [x] We talk about what a Probot app is in pretty deep detail, but we don't ever set up the expectation of what the WIP bot should do - at least if we do, comparatively it gets lost.

LL Function (@jasonetco)

• [ ] When I'm on the "progress" tab, I see "course dashboard". When I'm on the "details" tab, it goes away. https://github.com/github/learning-lab/issues/782

Issue 1

• [x] There's no header - is this consistent with other courses? Add headers.
• [x] Emojis after the periods for consistency across courses
• [x] "What's an application" is probably way too much text that's unnecessary
• [x] "Why would people use it?" what's it? Holy moly text dump!
• [x] GitHub is an app >> GitHub is a platform!!! Prune prune prune.
• [x] "I still don't see the difference"...wait were we comparing something? The difference between what? Rename. Remove dropdowns.

Comment 1

• [x] Prune down the text - way too much reading. Way too many categories in the table. What is it adding?
• [x] Table has an extra bottom row
• [x] Is assigning yourself to the issue actually helping show understanding of the text? It doesn't feel related at all.

Comment 2

• [x] Same thing, so much text, and the action doesn't seem related. These need to be related for the course flow to be meaningful. Things like assigning self, closing issue, are just like pressing a "next" button. I think this needs major rethinking and can probably be solved by taking away 70-80% of the text and removing the assignment step.
• [x] After closing the issue, I got stuck. Nothing commented in the issue, and I wasn't sure what to do next. https://github.com/githubtraining/introduction-to-github-apps/pull/10 Got error:

  Error: Action of type `createPullRequest` is missing the required property `head`.
  at config.options.filter.map.forEach.opt (/app/lib/utils/run-action.js:21:15)
  at Array.forEach (<anonymous>)
  at Context.module.exports (/app/lib/utils/run-action.js:19:6)
  at module.exports (/app/lib/utils/run-actions.js:9:36)
  at Course.runHandler (/app/lib/course.js:135:38)
  at <anonymous>

[brianamarie]

Going to start tackling these now 👀

[brianamarie]

I've started to address quite a bit of these here: https://github.com/githubtraining/introduction-to-github-apps/pull/11

[hollenberry]

pretty deep detail way too much text that's unnecessary Holy moly text dump! Prune prune prune. Prune down the text - way too much reading. Same thing, so much text

@brianamarie Thanks so much for sharing this sentiment. We received similar feedback from Cynthia yesterday, but unfortunately had to spend much of our day putting out some fires as we addressed broken apps/activities. This was first on the list for the morning, and it's already well on its way thanks to your effort ✨ .

• These need to be related for the course flow to be meaningful. Things like assigning self, closing issue, are just like pressing a "next" button. I think this needs major rethinking.

This was also something that concerned us. Our goal was to get things into a reliable/testable state and then make amendments from there, reusing re-appropriating, and likely reducing existing content from early in the course.

Hector proposed a cool structure that we'll look back into today, now that the course is testable.

Anyways, we're very much on the same page. Thank you so much for diving in!

[hollenberry]

• [ ] Apps or apps? Is Apps a proper noun? Applications?

The way I've seen it in the Probot documentation is... GitHub Apps, or apps standalone.

[brianamarie]

The way I've seen it in the Probot documentation is... GitHub Apps, or apps standalone.

Sounds good. Looks like if "GitHub" or "OAuth" is in front, then it's capitalized.

GitHub Apps are the officially recommended way to integrate with GitHub because they offer much more granular permissions to access data, but GitHub supports both OAuth Apps and GitHub Apps. For information on choosing a type of app, see "About apps" and "Differences between apps."

For a walkthrough of the process of building a GitHub App, see "Building Your First GitHub App."

• https://developer.github.com/apps/

I'll create new issues for the two unchecked boxes so we can close this issue. ✔️