fix: Small edits to the template

.github/dependabot.yml

@@ -6,8 +6,8 @@ updates:
     interval: daily
     time: "13:00"
   open-pull-requests-limit: 10
-  reviewers:
-  - dciborow
+  # reviewers:
+  # - dciborow
   allow:
   - dependency-type: direct
   - dependency-type: indirect

.github/template-sync.yml

@@ -1,14 +1,14 @@
 files:
-  - ".gitignore"  # include
+  - ".gitignore" # include
   - ".github"
   - ".vscode"
   - "tests/conftest.py"
   - ".flake8"
   - ".pre-commit-config.yml"
   - ".pypirc"
   - "docs"
-  - "src/README.md"
   - "CODE_OF_CONDUCT.md"
+  - "CONTRIBUTING.md"
   - "LICENSE"
   - "README.md"
   - "SECURITY.md"

.github/workflows/CI.yml

@@ -1,18 +1,22 @@
 name: Python CI
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
-    branches: [ main ]
+    branches: [main]
   release:
-    types: [created]    
+    types: [created]
   workflow_dispatch:
 
 jobs:
   validation:
-    uses: microsoft/action-python/.github/workflows/validation.yml@0.6.4
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+    uses: microsoft/action-python/.github/workflows/validation.yml@0.7.3
     with:
-      workdir: '.'
+      workdir: "."
+      python-version: ${{ matrix.python-version }}
 
   publish:
     uses: microsoft/action-python/.github/workflows/publish.yml@0.6.4

.github/workflows/publish.yml

@@ -4,7 +4,7 @@ on:
 
 jobs:
   publish:
-    uses: microsoft/action-python/.github/workflows/publish.yml@0.6.4
+    uses: microsoft/action-python/.github/workflows/publish.yml@0.7.3
     secrets:
       PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
       TEST_PYPI_PASSWORD: ${{ secrets.TEST_PYPI_PASSWORD  }}

.github/workflows/schedule-update-actions.yml

@@ -12,13 +12,13 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3.5.2
+      - uses: actions/checkout@v4.2.2
         with:
           # [Required] Access token with `workflow` scope.
           token: ${{ secrets.PAT }}
 
       - name: Run GitHub Actions Version Updater
-        uses: saadmk11/github-actions-version-updater@v0.7.4
+        uses: saadmk11/github-actions-version-updater@v0.8.1
         with:
           # [Required] Access token with `workflow` scope.
           token: ${{ secrets.PAT }}

.github/workflows/semantic-pr-check.yml

@@ -12,6 +12,6 @@ jobs:
     name: Validate PR title
     runs-on: ubuntu-latest
     steps:
-      - uses: amannn/action-semantic-pull-request@v5.2.0
+      - uses: amannn/action-semantic-pull-request@v5.5.3
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/sphinx.yml

@@ -6,13 +6,13 @@ on:
 
 jobs:
   pages:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     environment:
       name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
+      # url: ${{ steps.deployment.outputs.page_url }}
     permissions:
       pages: write
       id-token: write
     steps:
-    - id: deployment
-      uses: sphinx-notes/pages@v3
+      - id: deployment
+        uses: sphinx-notes/pages@v3

.github/workflows/template-sync.yml

@@ -5,7 +5,7 @@ jobs:
   sync:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3.5.2 # important!
+      - uses: actions/checkout@v4.2.2 # important!
       - uses: euphoricsystems/action-sync-template-repository@v2.5.1
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -127,3 +127,6 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+# Mac metadata files
+.DS_Store

CODE_OF_CONDUCT.md

@@ -1,9 +1,132 @@
-# Microsoft Open Source Code of Conduct
+# Contributor Covenant Code of Conduct
 
-This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+## Our Pledge
 
-Resources:
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
 
-- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)
-- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
-- Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

@@ -0,0 +1,120 @@
+<!--
+Update `package_name` to the name of the package.
+
+Remove the comment when this is done.
+-->
+
+# Contributing to package name
+
+<!--
+Update `package_name` to the name of the package.
+
+Remove the comment when this is done.
+-->
+
+🎉 Thank you for your interest in contributing to `package_name`!
+Your ideas, fixes, and improvements are welcome and appreciated.
+
+Whether you’re fixing a typo, reporting a bug, suggesting a feature, or submitting a pull request—this guide will help you get started.
+
+## 📌 How to Contribute
+
+1. Open an Issue
+
+<!--
+- Update the link to Issue.
+    - Update `username` to the user name or organization.
+    - Update `package_name` to the name of the package.
+
+Remove the comment when this is done.
+-->
+
+- Have a question, bug report, or feature suggestion? [Open an issue](https://github.com/username/package_name/issues/new/choose) and describe your idea clearly.
+- Check for existing issues before opening a new one.
+
+2. Fork and Clone the Repository
+
+<!--
+- Update the link to Issue.
+    - Update `username` to the user name or organization.
+    - Update `package_name` to the name of the package.
+
+Remove the comment when this is done.
+-->
+
+```shell
+git clone git@github.com:<username>/package_name.git
+cd package_name
+```
+
+3. Set Up Your Environment
+
+We recommend using a virtual environment:
+
+```shell
+python -m venv venv
+source venv/bin/activate  # on Windows: venv\Scripts\activate
+pip install -e ".[dev]"
+```
+
+4. Set Up Pre-commit Hooks
+
+We use pre-commit to ensure code quality and consistency. After installing dependencies, run:
+
+```shell
+pre-commit install
+```
+
+This ensures checks like code formatting, linting, and basic hygiene run automatically when you commit.
+
+5. Create a New Branch
+
+Give it a meaningful name like fix-typo-in-docs or feature-add-summary-option.
+
+6. Make Changes
+
+- Write clear, concise, and well-documented code.
+- Follow [PEP 8](https://pep8.org/) style conventions.
+- Add or update unit tests when applicable.
+
+7. Run Tests
+
+Ensure that all tests pass before opening a pull request:
+
+```shell
+pytest
+```
+
+8. Open a Pull Request
+
+Clearly describe the motivation and scope of your change. Link it to the relevant issue if applicable.
+The pull request titles should match the [Conventional Commits spec](https://www.conventionalcommits.org/).
+
+## 💡 Tips
+
+- Be kind and constructive in your communication.
+- Keep PRs focused and atomic—smaller changes are easier to review.
+- Document new features and update existing docs if needed.
+- Tag your PR with relevant labels if you can.
+
+## 📜 Licensing
+
+<!--
+Update the statement if a different license is used.
+
+Remove the comment when this is done.
+-->
+
+By contributing, you agree that your contributions will be licensed under the project’s MIT License.
+
+---
+
+<!--
+Update package_name to the name of the package.
+
+Remove the comment when this is done.
+-->
+
+Thanks again for being part of the package_name community!
+
+---

LICENSE

@@ -1,6 +1,6 @@
     MIT License
 
-    Copyright (c) Microsoft Corporation.
+    Copyright (c) Year Your name.
 
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to deal