Code Check Guide progress

[debruine]

I'd put an August 1 deadline on revising the outline. Thanks so much to all who had a look at it. If there are no objections, I'm going to tidy it up and create a document where we can start actually writing sections of the draft.

I'll post the outline here so people can claim sections to write the first draft. I think collaborative writing in Google Docs is easiest for a group of this size, and once the text is agreed, I can easily move it to a quarto book format. Let's use markdown formatting for the draft (e.g., # for headers and text for links) to make this transition easier.

[debruine]

📣 @code-check-club/members: I've set up a Google Doc for the Code Review Draft.

✏️ There are detailed instructions for how to contribute at the top of the document. It's very modular, so you can claim a section and just start writing. We'll worry about consistency in an integration pass after we've generated text for each section.

💻 Probably the easiest sections to claim are under the Topics/Concepts heading. You can write a standalone section on any topic you think is of importance for code review, such as documentation, unit tests, literate programming, or naming things.

[ha0ye]

Thanks for setting things up with a detailed framework! My own time and bandwidth is stretched thin, so I'm not sure how much I'll be able to contribute, but the modularity and scaffolding help immensely.

[debruine]

Thanks to everyone who has claimed a section so far. There are even a few that are ready for review! I've been looking at all the ones that are ready for review, but so this project doesn't end up too biased towards my experience and opinions, I'd like each section to be reviewed by 2 people. They're mostly short sections, so a review could take 5 minutes. The reviews at this stage are for clarity; don't worry too much about structure and integration with other sections; we'll assemble a small team to do the integration pass after all the sections are written.

I know it's a busy time of year for academics (honestly, when isn't?) and I really appreciate everyone's efforts on this. I think it will be an outstanding and useful resource when it's done.

[kaijagahm]

@debruine can you clarify how review should happen? Sorry if this is stated somewhere and I missed it... should we go ahead and make (reasonable, minimal) edits directly in the draft, or should we use "suggesting" mode to suggest changes and let the author(s) approve them?

[debruine]

I've added a short bit to the top of the document about reviewing. Use Suggesting mode to make edits (just so authors can see what changed), and do anything minor, like typos and grammatical corrections, in the text directly. You might want to use comments for larger, structural changes or suggestions that you're not 100% sure about.

If you end up adding a paragraph or more of extra text, also put that right in the draft and add yourself to the authors list for that section.

[EPronizius]

Dear all, what are our next steps?
I am not sure what I should do next :)

[mahmoud-elsherif]

What are our next steps for this project?

[shafieisabets]

Hi Lisa, I hope you are doing well. Are there any updates/news on the Code Review project? Kind regards Saeed

…

On Sun, Aug 14, 2022 at 4:42 PM Lisa DeBruine ***@***.***> wrote: 📣 @code-check-club/members <https://github.com/orgs/code-check-club/teams/members>: I've set up a Google Doc for the Code Review Draft <https://docs.google.com/document/d/1oU_wcxo4RQXvG72szW5H26VmAeJJhytjsw0UcQzV_l8/edit?usp=sharing> . ✏️ There are detailed instructions for how to contribute at the top of the document. It's very modular, so you can claim a section and just start writing. We'll worry about consistency in an integration pass after we've generated text for each section. 💻 Probably the easiest sections to claim are under the Topics/Concepts heading. You can write a standalone section on any topic you think is of importance for code review, such as documentation, unit tests, literate programming, or naming things. — Reply to this email directly, view it on GitHub <#3 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AB5U34BC7ZI7ZKRGRBTMVUTVZDPCDANCNFSM55KUH76Q> . You are receiving this because you are on a team that was mentioned.Message ID: ***@***.*** com>

-- <>< <>< <>< <>< <>< <>< <>< <>< *Dr. Saeed Shafiei Sabet* *Assistant Professor, Reader in Animal Behaviour, Bioacoustics* *Fisheries Department* Faculty of Natural Resources University of Guilan Phone # 98 13 443235 148 <callto:98+13+443235+148> Sowmeh Sara, 1144. Guilan, Iran Scopus <https://www.scopus.com/authid/detail.uri?authorId=56105807600> Google Scholar <https://scholar.google.nl/citations?user=15-XIMMAAAAJ&hl=en> ResearchGate <https://www.researchgate.net/profile/Saeed_Shafiei_Sabet> ORCID <https://orcid.org/0000-0001-5919-2527> <>< <>< <>< <>< <>< <>< <>< <><