Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: DHI/python-package-development
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: main
Choose a base ref
...
head repository: DHI/python-package-development
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: package-standards
Choose a head ref
Checking mergeability… Don’t worry, you can still create the pull request.
  • 5 commits
  • 7 files changed
  • 1 contributor

Commits on Aug 6, 2026

  1. Add distilled package standards page and review skill

    The course content is spread across seven slide decks, which makes it hard
    to point someone at a specific rule. standards.md distils it into ~45
    normative rules, one linkable heading each, published at standards.html.
    
    Exposition is deliberately left in the slides: the page holds only rules
    you would assert at someone, including ones no tool can check.
    
    Also folds in seven issues that never made it into the slides: #40 (the
    underscore convention, with the public-API-only amendment to breaking
    changes), #37 (cost of dependencies), #36 (long signatures), #35
    (inappropriate intimacy), #34 (comments say why), #33/#26 (deprecation),
    #22 (changelog).
    
    The review-python-package skill audits a repository against the page and
    links each finding to the rule it breaks.
    ecomodeller committed Aug 6, 2026
    Configuration menu
    Copy the full SHA
    fba8826 View commit details
    Browse the repository at this point in the history
  2. Address review comments on standards and review skill

    standards.md:
    - Keyword-only arguments: rewritten around positional count — one or two
      for the data, config after the `*`, three+ is the smell. Now Recommended.
    - Changelog demoted to Nice; hand curation is real work, so point at
      towncrier/git-cliff instead of prescribing it.
    - One return type: show the function, so the None path is visible.
    - New rules: Tag every release, Type checking in CI.
    - Publish from a tag or a release, showing the `on: push: tags` trigger.
    - Test the matrix: CI is not free; test only what you claim to support.
    - Docs: name Quarto, Great Docs and zensical as alternatives; replace the
      robots.txt note with access-controlled Pages on GitHub Enterprise.
    - Makefile becomes A task runner, covering `just` for Windows.
    - Fix checkout@v3 -> v4 and a backwards `min`/`max` in the clip example.
    
    review-python-package skill:
    - Use Glob/Read/Grep instead of `ls`, `cat` and piped `grep` — the reviewer
      may be on Windows with no POSIX shell. Table-escaped pipes had also made
      the mutable-default pattern match nothing.
    - `uvx ruff`, and say so when the repo has no ruff config.
    ecomodeller committed Aug 6, 2026
    Configuration menu
    Copy the full SHA
    0055f53 View commit details
    Browse the repository at this point in the history

Commits on Aug 25, 2026

  1. Configuration menu
    Copy the full SHA
    0a1f947 View commit details
    Browse the repository at this point in the history
  2. Teach just as the task runner

    The DHI python template migrated from a Makefile to a justfile, so the
    course now leads with just: cross-platform single binary, self-documenting
    via just --list. make is kept as a footnote.
    ecomodeller committed Aug 25, 2026
    Configuration menu
    Copy the full SHA
    a7e36f3 View commit details
    Browse the repository at this point in the history
  3. Tighten standards to normative one-liners

    - Cut exposition from the eleven multi-paragraph rules; every rule is now
      the rule plus its reason, no essays. All 45 anchors unchanged.
    - Fix the One return type example: the comment claimed a None path the code
      does not have.
    - Align requires-python (>=3.11) with the DHI template and with the CI
      matrix example, which previously contradicted it.
    - justfile excerpt in 03_testing was not runnable: check depended on a
      doctest recipe that was elided, and dropped the windows-shell line the
      cross-platform claim rests on.
    ecomodeller committed Aug 25, 2026
    Configuration menu
    Copy the full SHA
    63e17e3 View commit details
    Browse the repository at this point in the history
Loading