Merge pull request #90 from UBC-MDS/dev

Dev

Author: EricYangg

.github/workflows/preview-docs.yml

@@ -0,0 +1,90 @@
+# Netlify Preview Deployment Workflow
+on:
+  workflow_dispatch:
+  pull_request:
+
+name: Preview Documentation
+
+jobs:
+  render-docs-preview-deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      deployments: write
+      pull-requests: write
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up Quarto
+        uses: quarto-dev/quarto-actions/setup@v2
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.13'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .[docs]
+          
+      # register the Python kernel for Quarto/Jupyter    
+      - name: Register Jupyter kernel
+        run: |
+          python -m ipykernel install --user --name python3
+
+      - name: quartodoc build
+        run: |
+          quartodoc build
+
+      - name: Render Quarto Project
+        uses: quarto-dev/quarto-actions/render@v2
+
+      # =====================================================
+      # Deploy to Netlify
+      # =====================================================
+
+      # Create a unique name for this deployment using the PR number
+      # This helps track which PR preview is which
+      - name: Configure release name
+        run: echo "RELEASE_NAME=pr-${{ github.event.number }}" >> $GITHUB_ENV
+
+      # Create a deployment status on GitHub to track the deployment progress
+      # This shows up in the PR's "Deployments" section
+      - name: Create deployment status
+        uses: bobheadxi/deployments@v1
+        id: deployment
+        with:
+          step: start
+          token: ${{ secrets.GITHUB_TOKEN }}
+          env: ${{ env.RELEASE_NAME }}
+          ref: ${{ github.head_ref }}
+          logs: 'https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}'
+
+      # Deploy the rendered site to Netlify with a PR-specific preview URL
+      # The alias ensures each PR gets its own stable URL during review
+      - name: Deploy to Netlify
+        id: netlify
+        env:
+          NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
+          NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
+        run: |
+          npm install -g netlify-cli
+          netlify deploy --dir=_site/ --alias="pr-${{ github.event.number }}" 2>&1 | tee deploy.log
+          DEPLOY_URL=$(grep -oP 'https://[^\s]+' deploy.log | grep -E '(netlify\.app|--.*\.netlify\.app)' | head -n 1)
+          echo "url=${DEPLOY_URL}" >> $GITHUB_OUTPUT
+          
+      # Update the GitHub deployment status with success/failure and the preview URL
+      # This creates a clickable link in the PR to view the deployed preview
+      - name: Update deployment status
+        uses: bobheadxi/deployments@v1
+        if: always()
+        with:
+          step: finish
+          token: ${{ secrets.GITHUB_TOKEN }}
+          status: ${{ job.status }}
+          deployment_id: ${{ steps.deployment.outputs.deployment_id }}
+          env: ${{ steps.deployment.outputs.env }}
+          env_url: ${{ steps.netlify.outputs.url }}
+          logs: 'https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}'

.github/workflows/publish-test-pypi.yml

@@ -0,0 +1,41 @@
+name: Publish to Test PyPI
+
+on:
+  workflow_dispatch:
+  push:
+    tags:
+      - 'v*.*.*'
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: read
+
+    steps:
+      - name: Check-out repository
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.ref }}  # Add this line - checks out the exact tag
+          fetch-depth: 0  # Important: need full history for version detection
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.13'
+
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install .[dev]
+
+      - name: Build package
+        run: hatch build
+
+      - name: Publish to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          verbose: true
+          repository-url: https://test.pypi.org/legacy/
+          password: ${{ secrets.TEST_PYPI_API_TOKEN }}

.gitignore

@@ -249,4 +249,5 @@ _version.py
 
 # Quarto build output
 _build/
-*_files/
+*_files/
+_freeze/

CHANGELOG.md

@@ -5,10 +5,29 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
 
-- Upcoming features and fixes
+### Added
+
+- Added clearer, runnable example usage demonstrating all package functions and included a standalone `examples/usage.py` script and `tutorials/usage.qmd` vignette to the docs #64.
+- Annotated static test fixtures and mutation tests to make test cases reproducible and easier to review #58.
+
+### Changed
+
+- Fixed incorrect README instruction (`cd sudoku_validation`) and updated README #72.
+- Updated documentation to include the API reference pages and linked them from the site landing #64.
+- Replaced placeholder contact method with actual contact information #70.
+- Fixed Contributing section GitHub usernames #73.
+
+### Fixed
+
+- Adjusted Quarto configuration and documentation pages so the landing page and tutorial render correctly; enabled page TOC and sidebar linking to README sections #64.
+
+
+### Maintenance
+
+- Closed completed review issues and cleaned up untracked or unnecessary files and ignored temporary files.
+
+### Governance
+- Added discussion and reasoning for the license choice #61
 
-## [0.1.0] - (1979-01-01)
 
-- First release

CODE_OF_CONDUCT.md

@@ -62,7 +62,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-\[INSERT CONTACT METHOD\].
+https://github.com/UBC-MDS/Sudoku_Validation/issues.
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

CONTRIBUTING.md

@@ -7,15 +7,19 @@ Every little bit helps, and credit will always be given.
 
 You can contribute in many ways, for example:
 
-* [Report bugs](#report-bugs)
-* [Fix Bugs](#fix-bugs)
-* [Implement Features](#implement-features)
-* [Write Documentation](#write-documentation)
-* [Submit Feedback](#submit-feedback)
+- [Contributing](#contributing)
+  - [Example Contributions](#example-contributions)
+    - [Report Bugs](#report-bugs)
+    - [Fix Bugs](#fix-bugs)
+    - [Implement Features](#implement-features)
+    - [Write Documentation](#write-documentation)
+    - [Submit Feedback](#submit-feedback)
+  - [Get Started!](#get-started)
+    - [Pull Request Guidelines](#pull-request-guidelines)
 
 ### Report Bugs
 
-Report bugs at https://github.com/justinmak08, EricYangg, Maple018, Olytics/sudoku_validation/issues.
+Report bugs at <https://github.com/UBC-MDS/Sudoku_Validation/issues>.
 
 **If you are reporting a bug, please follow the template guidelines. The more
 detailed your report, the easier and thus faster we can help you.**
@@ -42,13 +46,13 @@ happy for any support that they can get.
 Sudoku_Validation could always use more documentation, whether as
 part of the official documentation, in docstrings, or even on the web in blog
 posts, articles, and such. Just
-[open an issue](https://github.com/justinmak08, EricYangg, Maple018, Olytics/sudoku_validation/issues)
+[open an issue](https://github.com/UBC-MDS/Sudoku_Validation/issues)
 to let us know what you will be working on so that we can provide you with guidance.
 
 ### Submit Feedback
 
 The best way to send feedback is to file an issue at
-https://github.com/justinmak08, EricYangg, Maple018, Olytics/sudoku_validation/issues. If your feedback fits the format of one of
+<https://github.com/UBC-MDS/Sudoku_Validation/issues>. If your feedback fits the format of one of
 the issue templates, please use that. Remember that this is a volunteer-driven
 project and everybody has limited time.
 
@@ -57,12 +61,12 @@ project and everybody has limited time.
 Ready to contribute? Here's how to set up Sudoku_Validation for
 local development.
 
-1. Fork the https://github.com/justinmak08, EricYangg, Maple018, Olytics/sudoku_validation
+1. Fork the <https://github.com/UBC-MDS/Sudoku_Validation>
    repository on GitHub.
 2. Clone your fork locally (*if you want to work locally*)
 
     ```shell
-    git clone git@github.com:your_name_here/sudoku_validation.git
+    git clone https://github.com/UBC-MDS/Sudoku_Validation.git
     ```
 
 3. [Install hatch](https://hatch.pypa.io/latest/install/).
@@ -104,3 +108,5 @@ Before you submit a pull request, check that it meets these guidelines:
    new functionality into a function with a docstring.
 3. Your pull request will automatically be checked by the full test suite.
    It needs to pass all of them before it can be considered for merging.
+### Discuss the use of development tools, GitHub infrastructure, and organizational practices you learned in this course and applied in your project. If you were to scale up your or another project, what tools, infrastructure and practices would you use and why?
+We picked up a lot of practical habits in this course, especially around using GitHub to keep our work organized and accountable. Issues and pull requests are our main way of breaking tasks down and making sure we know who is doing what. Automated tests and CI helped us catch mistakes early instead of deadline fighting. If this project grew bigger, I will probably want to improve on better use of github issues for planning so the team could stay coordinated. I will also invest more in documentation and code reviews because they make scaling a lot less chaotic and more developer friendly.