instructions for using git/github effectively for version control, collaboration, and code review

[traceybit]

it seems like providing information and tools for using git/github will be important. currently the SOP suggests using git for version control, but only goes so far as: "More advanced workflows for using Git and GitHub, such as using pull requests or branches, will vary from project to project." sections/skills that may be relevant for this section include:

• getting set up with git/github (emlab organization)
• repo organization
• protect the main
• working with branches
• version control with commits
• using issues
• effective workflows?
• using positron/vscode?
• leveraging code agents (e.g., claude code)?
• pull requests
• copilot?

although this is all relevant to code review in the sense that all these things create an environment where code review is possible/easier, it seems like only a subset of those items are strictly related to code review. i wonder if some/most of this actually becomes a different udpated subchapter for section 3 of the SOP? (note, section 3.4 is a chapter on internal code review, and will probably be updated/replaced by this effort. maybe we are going to end up modifying chapter 3 in general?

[gmcdonald-sfg]

Thanks @traceybit ! I think you're right that Chapter 3 of the SOW needs an overhaul in general, with a whole lot more guidance on advanced GH use. You're totally right that while some of these things are particularly relevant to code review, not all of them necessarily are.

Your list of topics looks great! Maybe just one more (which encompasses "protect the main"):

• Developing rulesets (perhaps we can get to a point where we have standard rulesets we recommend for all projects?)

I could definitely envision several different ways to structure the reorganize Chapter 3. But here's one idea:

1. Guiding principles for how to write and review code (here we establish GH as the basis of all our coding work; but we talk more about the why, rather than the how)
2. Effective use of GH (e.g., everything in Tracey's list)
3. Effective coding best practices (e.g., using formatters, functional programming, notebooks, etc)
4. Effective code review best practices (e.g., maybe some of the stuff from the tidyteam code review best practices?)

[traceybit]

here is the chapter 3 revision outline for use to work on in collaboration.