I held a Github introduction for the WCAG WG and EO WG.

1. This session will be recorded

2. Git & GithubGit & Github
An introduction
Eric Eggert
W3C/WAI
ee@w3.org
w3.org/People/Yatil

3. NoteNote
Different editors have different
preferences for using Github.
Please talk to the editor of the
delivery you want to contribute to.

4. ContributionsContributions
welcome!welcome!

5. GitGit
„Git is a distributed revision
control system with an emphasis on
speed, data integrity, and support
for distributed, non-linear
workflows.“

6. http://www.git-tower.com/learn/git/ebook/command-line/basics/what-is-version-control

7. RepositoryRepository
Stores all versions and
associated metadata for the
project

8. Local & RemoteLocal & Remote
RepositoriesRepositories
In Git, every computer has a
complete copy of the repository
(Local Repositories)
All changes can then be synced to a
central remote repository

9. CommitCommit
A Commit is a specific set of
changes that is submitted to the
repository, creating a new version
(of the committed files)
each commit has a “commit message”
that describes what was archived
with this commit

10. BranchesBranches

11. BranchesBranches
1. Easy to create
2. helps to concentrate on one change
3. can later be merged into the “main” branch
4. avoids collisions from multiple editors

13. no need for CLIno need for CLI

14. Source treeSource tree
Mac & Windows

15. Github for WindowsGithub for Windows
Windows

16. Github for MacGithub for Mac
Mac

17. GithubGithub

18. A GUI forA GUI for RemoteRemote RepositoriesRepositories
Cprovides other project management helpers,
such as:
Issue management
Wiki
Milestones

19. Each delivery has its ownEach delivery has its own
repositoryrepository
For example:
github.com/w3c/wai-tutorials/
github.com/w3c/wai-quick-start/
github.com/w3c/wai-wcag-quickref/

20. Edit FilesEdit Files
GithubGithubO

22. All kinds of file typesAll kinds of file types
HTML
CSS/SASS/…
JavaScript
PHP/Ruby/Python/…
Markdown
(Also w/ YAML FRONTMATTER)

23. ISSUESISSUES

25. PullPull
requestsrequests

27. Reference syntaxReference syntax
@username – notifies a user about a comment
(Pretty much like @-replies on Twitter)
#123 – References that issue
6f8bddc011 – references that commit

28. Github flavored MarkdownGithub flavored Markdown

29. When to useWhen to use
what?!what?!

30. IssuesIssues
General feedback
Discussing passages of documents
collecting opinions

31. WritingWriting
“good”“good”
IssuesIssues

32. Always provide a link to the pageAlways provide a link to the page
in questionin question
Or, if possible, a link to the section of the page

33. Keep the issue clear, concise andKeep the issue clear, concise and
focused on a specific issuefocused on a specific issue

34. Bad: “I don’t like content of page X”Bad: “I don’t like content of page X”
good: “On page X the wording in thegood: “On page X the wording in the
introduction is unclear.”introduction is unclear.”

35. Pull requestsPull requests
Concrete text/code proposals
implementing changes that have already been
discussed
Typos & grammar corrections

36. creatingcreating
“good”“good”
pull requestspull requests

37. Make “atomar” changesMake “atomar” changes
If there are multiple, independent wording
changes, create multiple pull requests
if it’s a change throughout a page (or repository),
one pull request is enough

38. Github workflowGithub workflow
Create branch

39. Github workflowGithub workflow
Commit changes

40. Github workflowGithub workflow
Open a pull request

41. Github workflowGithub workflow
Discuss and (optionally) add more commits

42. Github workflowGithub workflow
Merge