Skip to content

Commit

Permalink
add video links
Browse files Browse the repository at this point in the history
  • Loading branch information
d-chambers committed Mar 16, 2023
1 parent a374a24 commit a27be48
Show file tree
Hide file tree
Showing 9 changed files with 21 additions and 2 deletions.
2 changes: 2 additions & 0 deletions index.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ Welcome to OpenSourceCourse (OSC)!
OSC is designed to help engineering/science students learn to effectively contribute to the
open-source scientific python ecosystem.

You an find a video introduction [here](https://www.youtube.com/watch?v=b4ru68A31Uk)

# Learning Objectives

After successfully completing this course you will:
Expand Down
2 changes: 2 additions & 0 deletions modules/documentation/overview.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ Don't document the program; program the document.
\- Unknown
:::

[Video](https://www.youtube.com/watch?v=25jwO2_lAoI)

# Documentation
Documenting all software is important, but just like testing, selecting the appropriate level and strategy
depends on the type of software and its audience. For example, a simple script for producing a figure for a
Expand Down
2 changes: 2 additions & 0 deletions modules/functional_python/overview.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ Functional programming makes code understandable by minimizing moving parts.
\- Michael Feathers
:::

[Video](https://www.youtube.com/watch?v=52tYA0yH5bY)

# Functional Programming

Functional programming has a lot of different definitions. In a pure sense, it means abstractions
Expand Down
2 changes: 2 additions & 0 deletions modules/git/overview.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ So git is a very powerful set of tools.
\- Linus Torvalds
:::

[Video](https://www.youtube.com/watch?v=qzg6Toe0DVA)

# Git

Git is a class of software known as a version control system (VCS). It is used to help developers manage the
Expand Down
2 changes: 2 additions & 0 deletions modules/object_oriented_python/overview.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ Any sufficiently advanced technology is indistinguishable from magic.
\- Author C. Clarke
:::

[Video](https://www.youtube.com/watch?v=QbQbecAPU4M)

Python's popularity is in part due to its simplicity. However, unlike many other "simple" languages,
Python has many advanced features that, when used pragmatically, facilitate the expression of complex
concepts in a concise way. Knowing some of these features is necessary, not just to level up as a developer,
Expand Down
7 changes: 5 additions & 2 deletions modules/structure/images/science_repo_spectrum.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions modules/structure/overview.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ Clean code always looks like it was written by someone who cares.
\— Robert C. Martin
:::

[Video](https://www.youtube.com/watch?v=Q2SGLQofBvI)

Creating an effective, clean structure for a coding project is a challenge.
Large code structures follow [Conway's Law](https://en.wikipedia.org/wiki/Conway%27s_law) in that the
code will end up looking like the communication structure of the developers. Small open-source libraries,
Expand Down
2 changes: 2 additions & 0 deletions modules/style/overview.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ In character, in manner, in style, in all things, the supreme excellence is simp
\- Henry Wadsworth
:::

[Video](https://www.youtube.com/watch?v=QzadYpLpyqI)

# Style

Idiomatic Python, described with the abjective "Pythonic", is code that conforms to the Python community's norms and makes good use
Expand Down
2 changes: 2 additions & 0 deletions modules/testing/overview.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ Testing can be used to show the presence of bugs, but never to show their absenc
\ — Edsger W. Dijkstra
:::

[Video](https://www.youtube.com/watch?v=VYN4ZSdpCmw)

# Software Testing

Testing is probably the most important topic in software engineering. This is because malfunctioning software can have dire
Expand Down

0 comments on commit a27be48

Please sign in to comment.