You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: slides/section_4_collaborative_soft_dev.md
+5-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ jupyter:
23
23
- up until this point, the course has been primarily focussed on technical practices, tools, and infrastructure, and primarily from the perspective of a single developer/researcher, albeit within a team environment
24
24
- in this section, we are going to start broadening our attention to the collaborative side of software development
25
25
- there are primarily two practices that facilitate collaboration: code review and package release
26
-
- code review has many benefits, but top among them is that it provides a gate check on software quality,
26
+
- code review has many benefits, but top among them is that it provides a gate check on software quality,
27
27
- it is also a way to share knowledge within a team, improving the redundancy of that team (which is actually a good thing regardless of what corporate types might say!)
28
28
- getting another set of eyes on your code also means you are less likely to flout coding standards and convention
29
29
- there are many different types of code review, and we will explore the most common in this section
- We want our code to be somewhere on the "reusablility" spectrum
212
+
- We want our code to be somewhere on the "reusability" spectrum
213
213
- but where exactly? this will depend on the maturity of your code and how widely it will be used (similar to testing)
214
214
- at a minimum, we want to aim for reproducibility if we are publishing: someone else should be able to take our code and data and run it themselves and get the same result
215
215
- however, for big library packages, we probably want to bump that up to reusable, where our code is easy to use, understand, and modify
216
216
- Documentation is an important part of our code being reusable
217
217
- Even if you write incredibly expressive code, it will not be enough for someone new to start using and modifying your code base
218
218
- How do they install it? Are there any development tools they need? What is the scientific context and limitations of the code?
219
219
- We need to answer all of these questions and more if we want our code to be approachable and reusable
220
-
220
+
221
221
TODO would be nice to modify the image from <https://the-turing-way.netlify.app/_images/reproducible-definition-grid.svg> so that it better reflects the ACM definition of reproducibility/replicability
0 commit comments