Merge branch 'main' of https://github.com/seedcase-project/template-python-package into ci/update-workflows-from-template

Author: lwjohnst86

.editorconfig

@@ -15,7 +15,6 @@ max_line_length = 88
 # Have a bit shorter line length for text docs
 [*.{txt,md,qmd}]
 max_line_length = 72
-indent_size = 4
 
 # Python always uses 4 spaces for tabs
 [*.py]

.github/CODEOWNERS

@@ -1,2 +1,3 @@
-# All members on Developers team get added to review PRs
-* @seedcase-project/developers
+# Which team or person to inform for PRs that modify these files.
+# `*` means all files in the repository.
+* @seedcase-project/platform-templates @seedcase-project/admin

.github/dependabot.yml

@@ -6,4 +6,3 @@ updates:
       interval: monthly
     commit-message:
       prefix: ci
-      include: scope

.gitignore

@@ -48,6 +48,8 @@ _book
 public
 site
 
+# Cache folders
+*_cache/
 
 # Misc files
 *.log

.pre-commit-config.yaml

@@ -1,8 +1,8 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
 ci:
-  autofix_commit_msg: "chore(pre-commit): :pencil2: automatic fixes"
-  autoupdate_commit_msg: "ci(pre-commit): :construction_worker: update pre-commit CI version"
+  autofix_commit_msg: "chore: ✏️ automatic pre-commit hook fixes"
+  autoupdate_commit_msg: "ci: 👷 update pre-commit CI version"
 
 repos:
   - repo: https://github.com/gitleaks/gitleaks
@@ -15,14 +15,11 @@ repos:
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
+      - id: mixed-line-ending
+        args: [--fix=lf]
       - id: check-merge-conflict
         args: [--assume-in-merge]
 
-  - repo: https://github.com/commitizen-tools/commitizen
-    rev: v4.16.2
-    hooks:
-      - id: commitizen
-
   # Use the mirror since the main `typos` repo has tags for different
   # sub-packages, which confuses pre-commit when it tries to find the latest
   # version

.rumdl.toml

@@ -3,12 +3,12 @@
 line_length = 72
 flavor = "quarto"
 exclude = [
-    # Common directories to exclude
-    ".github",
-    # This is auto-generated from the qmd version
-    "**/README.md",
-    # This has it's own structure
-    "**/LICENSE.md"
+  # Common directories to exclude
+  ".github",
+  # This is auto-generated from the qmd version
+  "**/README.md",
+  # This has it's own structure
+  "**/LICENSE.md",
 ]
 
 # List style: `-`

.vscode/extensions.json

@@ -1,7 +1,7 @@
 {
   "recommendations": [
     "eamodio.gitlens",
-    "github.vscode-github-actions",
+    "GitHub.vscode-github-actions",
     "redhat.vscode-yaml",
     "donjayamanne.githistory",
     "felipecaputo.git-project-manager",
@@ -13,8 +13,8 @@
     "pshaddel.conventional-branch",
     "tekumara.typos-vscode",
     "EditorConfig.EditorConfig",
+    "samuelcolvin.jinjahtml",
     "rvben.rumdl"
   ],
-  // List of extensions recommended by VS Code that should not be recommended for users of this workspace.
   "unwantedRecommendations": []
 }

.vscode/settings.json

@@ -1,9 +1,5 @@
 {
-  "files.autoSave": "onFocusChange",
-  "editor.wordWrap": "off",
   "editor.formatOnSave": true,
-  "git.autofetch": false,
-  "editor.tabCompletion": "on",
   "editor.snippetSuggestions": "inline",
   "conventional-branch.type": [
     "build",
@@ -29,5 +25,7 @@
     "*.toml.jinja": "jinja-toml",
     "*.qmd.jinja": "jinja-md"
   },
-  "files.insertFinalNewline": true
+  "files.insertFinalNewline": true,
+  "conventionalCommits.emojiFormat": "emoji",
+  "conventionalCommits.promptScopes": false
 }

CONTRIBUTING.md

@@ -3,10 +3,8 @@
 ## :bug: Issues and bugs
 
 The easiest way to contribute is to report issues or bugs that you might
-find while using `template-python-package`. You can do this by creating
-a
-[new](https://github.com/seedcase-project/template-python-package/issues/new/choose)
-issue on our GitHub repository.
+find while using template-python-package. You can do this by creating a
+new issue on our GitHub repository.
 
 ## :pencil2: Adding or modifying content
 
@@ -22,12 +20,13 @@ justfile to manage our project, such as to run checks and test the
 template. Both the uv and justfile websites have a more detailed guide
 on using uv, but below are some simple instructions to get you started.
 
-It's easiest to install uv and justfile using
-[pipx](https://pipx.pypa.io/stable/), so install that first. Then,
-install uv and justfile by running:
+It's easiest to first
+[install uv](https://docs.astral.sh/uv/getting-started/installation/)
+and then install justfile with uv. Once you've installed uv, install
+justfile by running:
 
 ``` bash
-pipx install uv rust-just
+uv tool install rust-just
 ```
 
 We keep all our development workflows in the `justfile`, so you can
@@ -46,18 +45,63 @@ a terminal so that the working directory is the root of this project
 just run-all
 ```
 
-When testing the template, copier can only use content kept in the Git
+When testing the template, Copier can only use content kept in the Git
 history. Meaning that if you make changes to the template and try to
 test it, it won't be able to test those changes. You have to commit the
-changes first in order for copier to use them.
+changes first in order for Copier to use them.
 
 When committing changes, please try to follow
 [Conventional Commits](https://decisions.seedcase-project.org/why-conventional-commits/)
 as Git messages. Using this convention allows us to be able to
 automatically create a release based on the commit message by using
 [Commitizen](https://decisions.seedcase-project.org/why-semantic-release-with-commitizen/).
 If you don't use Conventional Commits when making a commit, we will
-revise the pull request title to follow that format, as we use
-[squash merges](https://git-scm.com/docs/git-merge) when merging pull
-requests, when merging pull requests, so all other commits in the pull
+revise the pull request title to follow that format, as we use squash
+merges when merging pull requests, so all other commits in the pull
 request will be squashed into one commit.
+
+## :file_folder: Explanation of files and folders
+
+This list describes the default files that are included in the template
+as well as explains a bit more about them and what they are used for.
+
+- `.copier-answers.yml`: Contains the answers you gave when copying the
+  project from the template.
+  **You should not modify this file directly.**
+- `.github/`: Contains GitHub-specific files, such as the workflow to
+  build the website from the Markdown files.
+- `_quarto.yml`: Quarto configuration file for the website, including
+  settings for the website, such as the theme, navigation, and other
+  options.
+- `.gitignore`: This ignore file tells Git which files to not track.
+  Unless you know what you are doing, it's best to not touch this file.
+- `.pre-commit-config.yaml`: [Pre-commit](https://pre-commit.com/)
+  configuration file for managing and running checks before each commit.
+- `.typos.toml`: [typos](https://github.com/crate-ci/typos) spell
+  checker configuration file.
+- `CITATION.cff`: Structured citation metadata for your project when
+  archived on [Zenodo](https://zenodo.org/) and used by GitHub to
+  display the citation information on the repository page. This is used
+  to add the metadata to Zenodo when a GitHub release has been uploaded
+  to Zenodo.
+- `justfile`: [`just`](https://just.systems/man/en/) configuration file
+  for scripting project tasks.
+- `.editorconfig`: Editor configuration file for
+  [EditorConfig](https://editorconfig.org/) to maintain consistent
+  coding styles across different editors and IDEs.
+- `CHANGELOG.md`: Changelog file for tracking changes in the project.
+- `CONTRIBUTING.md`: Guidelines for contributing to the project.
+- `.github/`: Contains GitHub-specific files, such as issue and pull
+  request templates, workflows,
+  [dependabot](https://docs.github.com/en/code-security/tutorials/secure-your-dependencies/dependabot-quickstart-guide)
+  configuration, pull request templates, and a
+  [CODEOWNERS](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)
+  file.
+- `_metadata.yml`: Quarto metadata file for the website, including
+  information about the project, such as the titles and GitHub names.
+- `.rumdl.toml`: [rumdl](https://rumdl.dev) configuration file for
+  formatting Markdown files in the project.
+- `cog.toml`: [Cocogitto](https://docs.cocogitto.io) configuration file
+  for managing versions.
+- `.config/cliff.toml`: [git-cliff](https://git-cliff.org) configuration
+  file for creating the changelog.

LICENSE.md

@@ -1,21 +1,22 @@
 # MIT License
 
-Copyright (c) 2023-2025 template-python-package authors
+Copyright (c) 2023-2026 template-python-package authors
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.