gw-ospo / gw-ospo/version-control-tutorial

Version Control Tutorial various comments

Open
#1 1 comment 0 reactions 1 assignee Claimed by @s2t2 View on GitHub
Dominant language
Makefile
Stars
1
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Various comments from my review of the content

- Do we want to have the same scope as the licensing tutorial to help limit & narrow the content? Specifically do we want to add "for Researchers and Educators"?
- In the Open Source Software section, the presentation does not have any context provided. Is it redundant or meant to provide more details? I like it, but it feels like it is floating here and I'm not sure about the purpose of including it and highlighting it by putting it first.
- In the Why Open Source section, if you focus on researchers and educators, then you could add something about citations and specifically it might be nice to encourage people to put a CITATION.cff file in their github repos.
- Another important addition to the "Why Open Source" section is that you will not lose access to your code when you move to a new organization or company.
- I'm not sure if this belongs in the "How to Open Source" section or later in the tutorial, but I love the [repo-scaffolder](https://github.com/DSACMS/repo-scaffolder/blob/main/maturity-model-tiers.pdf) as a guide to which files you should include in your project depending on it's maturity.
- At the end of the "Version Control Overview" section is it enough to have the Terminology section or do you need more details about these concepts?
- In the Gitub section or before do you need to explain the difference between git and GitHub (technology versus implementation)
- Is Github desktop necessary or is github through the browser fine (what are the differences if any)?
- Do we need to explain github enterprise and about creating orgs and whether to attach to the enterprise or keep separate?

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.