carpentries-incubator / carpentries-incubator/swc_github_flow

Additional definitions required

Open
#31 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
12
Forks
9
PR merge metrics
No merged PRs in 30d

Description

The definitions at the top of the lesson include the definition of _repository_, _origin_, _remote copy_, and _upstream_, but additional terms are used throughout the lesson when referring to various forms of the various repositories. Because several of these terms are used interchangeably, it might be worth it to add more definitions, or add the additional terms to the existing definitions. I've found reference to master repository, default repository, online repository, original repository (which can get confused with origin repository), local repository, main repository, and base repository. New and novice users of GitHub may find it difficult to keep track of the different names used throughout the lesson.

It may even be useful to include some sort of a visualization of branches and forks of repositories with their "names" in order to provide another perspective.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start at the definitions at the top of the lesson and scan the lesson for the repository terms listed in the issue, noting where names are used interchangeably. Done means the relevant terminology is defined or added to the existing definitions, with a repository branch/fork visualization included if that approach is chosen.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, github
Domain
content, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.