From b97d5292634351698515a9c308b4825fb9812ae3 Mon Sep 17 00:00:00 2001 From: walovens Date: Tue, 16 Apr 2024 15:49:30 -0400 Subject: [PATCH 1/2] fix a typo in the first line of section 2.5.1 #38 --- 02-github-in-practice.Rmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/02-github-in-practice.Rmd b/02-github-in-practice.Rmd index 568f60f..bc724f7 100644 --- a/02-github-in-practice.Rmd +++ b/02-github-in-practice.Rmd @@ -174,7 +174,7 @@ What are the features of git (independent of GitHub) to use commit messages as c ### Guidelines for using commits -The central feature of most version control system is the "commit" we describe above. nd version control, at it's heart, is a system for software developers to communicate. Understanding the motivation and context of the 'git commit' is key to interpreting a code repository. +The central feature of most version control system is the "commit" we describe above. And version control, at it's heart, is a system for software developers to communicate. Understanding the motivation and context of the 'git commit' is key to interpreting a code repository. A git commit and the associate message should communicate: From 42cca0b0cf2df275d142ffcbf2eaa6628bb591c9 Mon Sep 17 00:00:00 2001 From: walovens Date: Tue, 16 Apr 2024 15:56:57 -0400 Subject: [PATCH 2/2] fix typo in "issue" in section 2.6 #35 --- 02-github-in-practice.Rmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/02-github-in-practice.Rmd b/02-github-in-practice.Rmd index bc724f7..ec4c1e5 100644 --- a/02-github-in-practice.Rmd +++ b/02-github-in-practice.Rmd @@ -264,7 +264,7 @@ Effective commits are an important communication tool for your collaborators, yo ## GitHub issue tracking -We've mentioned GitHub issue tracking several times. While isse tracking is not a git feature or necessary to use git, this feature has been a cornerstone of open source collaboration within and outside of software development teams. +We've mentioned GitHub issue tracking several times. While issue tracking is not a git feature or necessary to use git, this feature has been a cornerstone of open source collaboration within and outside of software development teams. The basic concept of an issue and its' use is very simple. The second example of a commit above from the CRAWL project has an associated GitHub issue, and we know this because the dev who made the commit added a summary message "*longlat or geographic coordinate reference systems are not supported. this adds explicit checks and throws an error if geographic coordinates are provided. Fixes #39*" GitHub automatically links the issue ID number to the web page for the issue, which is ["add error catch when `sf` object is in 4326"](https://github.com/NMML/crawl/issues/39). Because the commit states it fixes this issue, we can assume that all the code necessary is in the commit, which you can confirm in the diff.