Open-Source Software Development Flow

---

# Lecture 2a: Open-Source Software Development Flow

@luk036 👨‍💻 · 2026 📅

---

## Key Insights 💬

- **High failure rate**: ~99% of projects fail 🚨
- **Software vs. Hardware**: "Soft" vs. "Hard" 💻
- **Automation challenges** ⚙️
- **Nightly builds** (Microsoft concept) 🌙
- **Agile development** 🏃
- **Pair programming** 👥
- **Extreme programming** 🔥
- **Open-source CI/CD** 🛠️

]

![Open Source Development](figs/open-source-software-development.svg)

]

---

### Software Development Flow 🔄

<pre>
graph LR
 A("💻 Code") --> B("🔨 Build")
 B --> C("🧪 Test")
 C --> D("👁️ Review")
 D --> E("🚀 Deploy")
 E -.-> A
 style A fill:#c8e6c9,stroke:#2e7d32,stroke-width:3px
 style B fill:#e3f2fd,stroke:#1565c0,stroke-width:3px
 style C fill:#fff3e0,stroke:#e65100,stroke-width:3px
 style D fill:#f3e5f5,stroke:#7b1fa2,stroke-width:3px
 style E fill:#ffcdd2,stroke:#c62828,stroke-width:3px
</pre>

]

---

### Development Platforms 🖥️

- **[GitHub](https://github.com)** 🐙🌐
- **GitHub Codespaces** ☁️
- **Lubuntu** 🐧
- **Windows** (MSVC++) 🪟
- **FydeOS** (ChromeOS, g++-14) 🌐
- **Android Termux** (clang-18) 📱

---

### Python Development Workflow 🐍

![Python Workflow](figs/python-flow.svg)

---

### 🛠️ C++ Development Workflow

![C++ Workflow](figs/cpp-flow.svg)

---

### Pull Request Process 🔀

![Pull Request Flow](figs/pull-request.svg)

]

]

---

### GitHub & Git Fundamentals 🐙

```bash
git clone https://github.com/luk036/csdigit
cd csdigit
# Make your changes
git status
git diff
git diff README.md
git pull
git add .
git commit -m "Your commit message"
git push
git tag
git branch          # List all branches
git branch develop  # Create new branch
git switch develop  # Switch to branch
git switch master   # Switch back to master
```

---

### Example: git status 📚

.font-sm.mb-xs[

```terminal
ubuntu@ubuntu:~/github/ellalgo$ git status
On branch master
Your branch is up to date with 'origin/master'.

Changes not staged for commit:
 (use "git add <file>..." to update what will be committed)
 (use "git checkout -- <file>..." to discard changes in working directory)

modified: .pytest_cache/v/cache/lastfailed
 modified: .pytest_cache/v/cache/nodeids

Untracked files:
 (use "git add <file>..." to include in what will be committed)

ellalgo/
 test.html

no changes added to commit (use "git add" and/or "git commit -a")
```

]

---

### Example: git pull 📚

.font-sm.mb-xs[

```terminal
lubuntu@lubuntu:~/github/luk036.github.io$ git pull
remote: Enumerating objects: 29, done.
remote: Counting objects: 100% (29/29), done.
remote: Compressing objects: 100% (8/8), done.
remote: Total 19 (delta 14), reused 16 (delta 11), pack-reused 0
Unpacking objects: 100% (19/19), done.
From ssh://github.com/luk036/luk036.github.io
 461191c..d335266 master -> origin/master
Updating 461191c..d335266
Fast-forward
 algo4dfm/swdevtips.html | 36 ++++++++--
 algo4dfm/swdevtips.md | 27 +++++++-
 algo4dfm/swdevtools.html | 22 +++++--
 algo4dfm/swdevtools.md | 89 ++++++++++++++++++++++++-
 markdown/remark.html | 45 ++++++++-----
 5 files changed, 251 insertions(+), 198 deletions(-)
```

]

---

### GitHub CLI (gh) 🐙

```bash
gh auth login
gh repo create csdigit --public
gh repo clone csdigit
gh run list
gh run view
gh release list
gh release create
gh issue list
gh issue create
gh search repos digraphx
```

---

### Python Development 🐍

- **Create new project** 🆕

```bash
  pip install pyscaffold[markdown]
  putup -i --markdown --github-actions csdigit
  ```

- **Setup** ⚙️

```bash
  cd csdigit
  pip install -e .
  pip install -r requirements.txt
  ```

- **Unit Testing** 🧪

```bash
  pytest
  pytest --doctest-modules src
  ```

- **Code Coverage** ☂️

```bash
  pytest --cov=src/csdigit
  ```

---

### Python Tooling 🐍

- **Formatting & Static Analysis** 🪄

```bash
  ruff format
  ruff check
  ruff check --fix
  ```

- **Documentation** 📝

```bash
  pip install -r docs/requirements.txt
  cd docs
  make html
  cd _build/html
  python -m http.server
  ```

- **Benchmarking** 📊

```bash
  pytest benches/test_bench.py
  ```

---

### Benchmarking Example 📊

.font-sm.mb-xs[

```terminal
ubuntu@ubuntu:~/github/ellalgo$ pytest tests/test_lmi.py
============================= test session starts ==============================
platform Linux -- Python 3.7.3, pytest-5.1.2, py-1.8.0, pluggy-0.13.0 -- /media/ubuntu/casper-rw/miniconda3/bin/python
cachedir: .pytest_cache
benchmark: 3.2.2 (defaults: timer=time.perf_counter disable_gc=False min_rounds=5 min_time=0.000005 max_time=1.0 calibration_precision=10 warmup=False warmup_iterations=100000)
rootdir: /media/ubuntu/casper-rw/github/ellalgo, inifile: setup.cfg
plugins: benchmark-3.2.2, cov-2.7.1
collecting ... collected 2 items

tests/test_lmi.py::test_lmi_lazy PASSED [ 50%]
tests/test_lmi.py::test_lmi_old PASSED [100%]

------------ benchmark: 2 tests -----------
Name (time in ms) Min Max Mean StdDev Median IQR Outliers OPS Rounds Iterations
-------------------------------------------
test_lmi_lazy 13.0504 (1.0) 13.2587 (1.0) 13.1461 (1.0) 0.0432 (1.91) 13.1471 (1.0) 0.0514 (1.66) 25;1 76.0682 (1.0) 75 1
test_lmi_old 13.6855 (1.05) 13.7888 (1.04) 13.7279 (1.04) 0.0225 (1.0) 13.7271 (1.04) 0.0310 (1.0) 24;1 72.8445 (0.96) 72 1
-------------------------------------------

Legend:
 Outliers: 1 Standard Deviation from Mean; 1.5 IQR (InterQuartile Range) from 1st Quartile and 3rd Quartile.
 OPS: Operations Per Second, computed as 1 / Mean
============================== 2 passed in 3.27s ===============================
```

]

---

### Rust Development 🦀

- **Create new project** 🆕

```bash
 cargo install cargo-generate
 cargo generate -o --init --git <https://github.com/rust-github/template.git>
 ```

- **Setup** ⚙️

```bash
  cd csd-rs
  cargo build --release
  ```

- **Unit Testing** 🧪

```bash
  cargo test --release
  cargo test --lib --release
  cargo test --doc --release
  ```

- **Code Coverage** (Linux) ☂️

```bash
  cargo llvm-cov
  ```

---

### Rust Tooling 🦀

- **Formatting & Static Analysis** 🪄

```bash
  cargo fmt
  cargo clippy
  cargo clippy --fix
  ```

- **Documentation** 📝

```bash
  cargo doc
  cd target/doc
  python -m http.server
  ```

- **Benchmarking** 📊

```bash
  cargo bench
  ```

---

### C++ (CMake + CPM) 🏗️

- **Create new project** 🆕
  Use GitHub's ModernCppStarter template

- **Setup** ⚙️

```bash
  cd csd-cpp
  cmake -Sall -Bbuild -DCMAKE_BUILD_TYPE=Release
  cmake --build build
  ```

- **Unit Testing** 🧪

```bash
  cmake --build build --target test
  ```

- **Code Coverage** ☂️
  (Implementation needed)

---

### C++ (CMake + CPM) Tooling 🏗️

- **Formatting & Static Analysis** 🪄

```bash
  pip install cmake-format clang-format
  cmake -Sall -Bbuild -DCMAKE_BUILD_TYPE=Release
  cmake --build build --target fix-format
  ```

- **Documentation** 📝

```bash
  cmake --build build --target GenerateDocs
  ```

- **Benchmarking** 📊

```bash
  ./build/bench/BM_switch
  ```

---

### C++ (XMake) 🏗️

- **Create new project** 🆕

```bash
  xmake create -t static lds-cpp
  xmake create -t console csd-cpp
  ```

- **Setup** ⚙️

```bash
  xmake f -m debug
  xmake
  ```

- **Unit Testing** 🧪

```bash
  xmake run test_csd
  ```

- **Code Coverage** ☂️
  (Implementation needed)

---

### C++ (XMake) Tooling 🏗️

- **Formatting** 🪄

```bash
  xmake format
  ```

- **Documentation** 📝
  ❌ xmake doxygen (Not working)

- **Benchmarking** 📊

```bash
  xmake run test_bench
  ```

---

## Q&A 🎤

]

![Q&A](figs/questions-and-answers.svg)

]