Classroom
Could be made more concise
18 Matching Annotations
- Apr 2022
-
sortee-github-hackathon.github.io sortee-github-hackathon.github.io
-
-
commits as a way to record daily progress issues as a way to keep track of short-term objectives/goals, and progress towards them
Worth fleshing this bit out, I think!
-
An even easier way to start using Github is for the archival of cleaned code and data
I don't think we should be recommending this; it's not a good long-term storage solution, and the contributor remains in control of the data/code (can retract at any time) so it's always better to put on a third party platform. Of course, GitHub is a good supplement to longer-term data & code archiving sites that can provide a look into the history & future of a given project.
-
data
Not sure we want to suggest use of GitHub for backing up data?
-
Box 2
I would make sure the use case descriptions are all in active voice (for example, "Co-authors can use as a forum to discuss" instead of "Can be used as a forum to discuss")
-
n Git, versions of files and directories are uniquely identified as “commits”, allowing one to identify and track modifications line-by-line.
Maybe this detail can be saved for the glossary box?
-
The Jenny Bryan universe of GitHub material
This one feels oddly specific in comparison to the others in this list. I think it makes sense to try to reframe these 10 tips so they are a little more timeless (like 1, 2, 3, 7, 8) rather than specific tools
-
migrate their workflows to
establish their workflows using?
-
Because not all GitHub features are essentially useful for every researcher, we allocate existing development and collaborative workflows within Github – such as, tracking tasks, discussing edits to a manuscript, and submitting code to a repository – to the most common research development roles in ecology and evolution (project manager, coauthor, code contributor).
Sentence is a bit clunky. "Given that members of a research team may have different technical skills and responsibilities, we describe how the optimal use of GitHub features may vary among members of a research collaboration. For example..."
-
essentially
cut
-
Add "other" in there to indicate that we are part of this group
-
have been encouraged
Passive voice a bit strange; who is doing this encouraging?
-
this
specify what "this" is ("this growing role of data science?")
-
have become critically
"are increasingly dependent" may be more accurate
-
Ecological and evolutionary researchers
Change to "Researchers in ecology and evolutionary biology"
-
h
Be consistent w/ capitalization throughout
-
(Part 1)
I assume these headings will be gone from the final manuscript?
-
Caveat that GitHub has been called out for not being so user-friendly for manuscript development
Could even reflect on our own experiences here! I for one have found it a little challenging to get into 'writing mode' in the GitHub framework
-