training-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Stephan Harbauer (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (TRAINING-19) Github Beginner Level Training material
Date Mon, 05 Aug 2019 11:44:00 GMT

    [ https://issues.apache.org/jira/browse/TRAINING-19?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16900024#comment-16900024
] 

Stephan Harbauer commented on TRAINING-19:
------------------------------------------

+{color:#1c1e29}General comments:{color}+

{color:#1c1e29}First of all, thanks for sharing and a great idea to open source it :){color}

{color:#1c1e29}After reading through the slide deck, I asked myself: is this a slide deck
for a workshop where someone is doing the training or should this slide deck also work for
self-teaching? As training, it's a pretty good deck. But I could imagine for the Apache Foundation;
it's more helpful if it would be more self-explaining? If this is the case, maybe a webpage
instead of a slide deck could be more {color}{color:#1c1e29}helpful{color}{color:#1c1e29}?{color}

 

+Comments on the structure:+
{color:#1c1e29}As far as I understood the slide deck, it currently has the following structure.
I like the structure and would {color}{color:#1c1e29}just{color}{color:#1c1e29} add three
little things.{color}

 

{color:#1c1e29}(1) Committer explained{color}

{color:#1c1e29}({color}*missing*{color:#1c1e29}) Contributor is not defined (or is the committer
in Apache wording the contributor?){color}

{color:#1c1e29}(2) Readme (Project setup) explained{color}

{color:#1c1e29}({color}*missing*{color:#1c1e29}) The motivation for a good readme is missing:
why you want other people to understand how to contribute so that they can help you{color}

{color:#1c1e29}(3) Git/Github basics{color}

{color:#1c1e29}(3.1) user and ssh keys or tokens (setup Git and Github){color}

{color:#1c1e29}(3.2) Git Flows (GitHub Flow aka branch or fork){color}

{color:#1c1e29}(3.3 Git branch model{color}

{color:#1c1e29}(3.4) Git stages (stash, local repo, remote repo{color}{color:#1c1e29}...{color}{color:#1c1e29})
incl. Push and Pull{color}

{color:#1c1e29}(3.5) {color}{color:#1c1e29}Reflog{color}

{color:#1c1e29}(4) Pull Requests + Reviews{color}

{color:#1c1e29}(4.1) How to create a PR{color}

{color:#1c1e29}(4.2) Make a good PR{color}

{color:#1c1e29}(4.3) Review (How to?){color}

{color:#1c1e29}({color}*missing*{color:#1c1e29}) When to open the PR? (at the beginning of
the implementation to allow others to follow the progress or at the end when everything is
perfect){color}

{color:#1c1e29}(5) Merge or Rebase{color}

{color:#1c1e29}(5.1) Explain both{color}

{color:#1c1e29}(5.2) Show potential issues when used "wrong."{color}

{color:#1c1e29}(6) Tips and tricks{color}

{color:#1c1e29}(7) Tooling{color}

{color:#1c1e29}(7.1) Review Tooling{color}

{color:#1c1e29}(7.2) History tooling{color}

{color:#1c1e29}(7.3) Project configuration{color}

{color:#1c1e29}(7.4) Templates for project configuration{color}

{color:#1c1e29}(7.5) Failure prevention with automation{color}

 

 
+{color:#1c1e29}Detail comments on specific slides:{color}+

{color:#1c1e29}- Slide 8: what does this mean? Committer, Project management committee{color}{color:#1c1e29}...{color}{color:#1c1e29}
here I need an explanation of what this slide should communicate.{color}

{color:#1c1e29}Slide 9: What are the accountabilities of a committer -> maybe add: Companies
that build SAAS products and have the practice of 'you build it, you run it' also means that
the (trusted) committers need to take over the responsibility of operating the contribution.{color}

{color:#1c1e29}Slide 20-22: Maybe an explanation slide to show we have two different approaches
on how to contribute via Git(Hub). Otherwise, newbies could get lost.{color}

{color:#1c1e29}Slide 23f.: Collaborating: More than one remote -> Within a training, the
slides are excellent. Just scroll the slides without the trainer explaining everything it's
not understandable if you are new to forks. Explanations on the slides or within the speaker
note section should help{color}

{color:#1c1e29}Slide 32f.: Making changes -> I don't understand (based on the pictures
and speaker notes) how branches, merges and rebases are working. There is also plenty of space
on the slides. More explanations {color}{color:#1c1e29}on{color}{color:#1c1e29} the slides
could help.{color}

{color:#1c1e29}Slides 44f.: Same as before - even worse{color}

{color:#1c1e29}Slide 56: Excercise 1 -> another slide with the learnings should help to
validate their own experiences during the exercise.{color}

{color:#1c1e29}Slide 62: "Pull these pull requests together in one issue." -> What do you
mean by that? Github Issues from the project management feature?{color}

{color:#1c1e29}Slide 63: Could also explain that different level of pull request comments
are available and should be used ({color}{color:#1c1e29}like:{color}{color:#1c1e29} mandatory
change, and nice to have {color}{color:#1c1e29}change{color}{color:#1c1e29}){color}

{color:#1c1e29}Slide 71: Excercise 3 -> add {color}{color:#1c1e29}an additional{color}{color:#1c1e29}
slide to explain what (should have) happened during the exercise.{color}

 

 

{color:#1c1e29}Once again: it's an awesome initiative to open source this. Let me know how
you like to continue. I'm happy to support.{color}

> Github Beginner Level Training material
> ---------------------------------------
>
>                 Key: TRAINING-19
>                 URL: https://issues.apache.org/jira/browse/TRAINING-19
>             Project: Apache Training
>          Issue Type: New Feature
>            Reporter: Isabel Drost-Fromm
>            Priority: Major
>
> A couple weeks ago we ran a Github training at Europace. As most of what we explained
there is based on the concept of Inner Source which itself is fairly close to the Apache Way
I thought it might make sense to submit an adapted version here.
> Caveat: Slides currently live in Google Slides. So we'd need to figure out how best to
convert them into a format the works for you.
> Caveat 2: Most of the Slides contain only graphics.
>  
> I'll need to go over them and translate from German to English anyway, however I'd rather
do that only once ;)



--
This message was sent by Atlassian JIRA
(v7.6.14#76016)

Mime
View raw message