Create release 3.0.0

[yhouyang02]

This pull request introduces several infrastructure improvements, documentation enhancements, and codebase updates to support better development practices, automated versioning, and improved project visibility. The most significant changes are the addition of dynamic versioning with Hatch, new GitHub Actions workflows for code coverage and documentation previews, expanded documentation and badges, and updates to the minidict dataset.

Infrastructure and Automation:

• Added dynamic versioning using hatch-vcs, including configuration in pyproject.toml and a generated src/wordguess/__version__.py file to automatically track and expose the package version. [1] [2] [3] [4] [5] [6]
• Added GitHub Actions workflow for code coverage reporting via Codecov and updated the test workflow to generate XML coverage reports.
• Added GitHub Actions workflow for previewing documentation on pull requests, deploying to Netlify with PR-specific URLs, and updating deployment status in GitHub.
• Updated deployment workflow to trigger on version tags instead of pushes to main, supporting semantic versioning and manual dispatch.

Documentation and Project Visibility:

• Added badges to README.md for TestPyPI version, build status, code quality, and documentation status, and improved installation and usage examples with a step-by-step tutorial. [1] [2]
• Added CHANGELOG.md to the documentation site and navigation, and recorded new features and improvements for version 3.0.0. [1] [2] [3]
• Expanded CONTRIBUTING.md with a detailed section on development tools, GitHub infrastructure, organizational practices, and scaling recommendations for larger projects.

Code and Dataset Updates:

• Added new words to the built-in minidict dataset to improve game variety. [1] [2]
• Improved docstrings in get_n_guesses.py for clarity and consistency, including parameter and error documentation. [1] [2] [3]

[codecov]

Codecov Report

❌ Patch coverage is 73.68421% with 5 lines in your changes missing coverage. Please review.
⚠️ Please upload report for BASE (main@4895f6e). Learn more about missing BASE report.

Files with missing lines	Patch %	Lines
src/wordguess/__version__.py	72.22%	4 Missing and 1 partial ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #92   +/-   ##
=======================================
  Coverage        ?   97.67%           
=======================================
  Files           ?       11           
  Lines           ?      430           
  Branches        ?       69           
=======================================
  Hits            ?      420           
  Misses          ?        6           
  Partials        ?        4           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[Copilot]

Pull request overview

Prepares the project for the 3.0.0 release by introducing dynamic versioning, improving CI/CD automation, and expanding project documentation and visibility.

Changes:

• Added Hatch VCS-based dynamic versioning and exposed package version via __version__.
• Introduced/updated GitHub Actions workflows for docs previews, code coverage uploads, and tag-based deployments.
• Expanded documentation (README, Quarto nav, CONTRIBUTING, CHANGELOG) and updated the built-in minidict dataset.

Reviewed changes

Copilot reviewed 15 out of 15 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
src/wordguess/result_to_pattern.py	Docstring formatting/clarity updates and inline comments.
src/wordguess/get_score.py	Docstring adjustments and added inline comments around scoring logic.
src/wordguess/get_result.py	Docstring clarification and “See Also” additions.
src/wordguess/get_n_guesses.py	Docstring cleanup to match NumPy style.
src/wordguess/_internals.py	Added new words to the built-in minidict.
src/wordguess/version.py	Added generated version module intended for dynamic versioning.
src/wordguess/init.py	Exposed __version__ at package import level.
pyproject.toml	Enabled dynamic versioning via hatch-vcs and configured version-file generation.
_quarto.yml	Added CHANGELOG to documentation project and navigation.
README.md	Added badges and expanded step-by-step usage example.
CONTRIBUTING.md	Added detailed development tooling/infrastructure guidance.
CHANGELOG.md	Added release notes section for 3.0.0.
.github/workflows/docs-preview.yml	New workflow to build and deploy PR docs previews to Netlify.
.github/workflows/deploy.yml	Updated publishing workflow triggers to run on version tags.
.github/workflows/build.yml	Updated test workflow to generate XML coverage and upload to Codecov.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Typo: “Please not that” should be “Please note that”.

Suggested change

	Please not that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
	Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.

[Copilot]

The Markdown table is malformed: the “Meta” row is missing the trailing |, which breaks table rendering in many viewers. Add the closing pipe (and keep column alignment consistent with the other rows).

[Copilot]

This version file header says it was generated by setuptools-scm and “don’t track in version control”, but this repo is configured for Hatch (hatch-vcs) and the file is committed in this PR. Update the header to reflect the actual tool/process, or stop committing the generated file and adjust runtime version retrieval accordingly.

Suggested change

	# file generated by setuptools-scm
	# don't change, don't track in version control
	# Version information for the wordguess package.
	# This file is maintained by the packaging/release process; do not edit by hand.

[Copilot]

__version__ is hard-coded to 1.0.0.post1.dev60, which will drift from the actual VCS/tag version and contradicts the intended 3.0.0 release. For dynamic versioning, ensure this module is generated during build from VCS metadata (or compute version at runtime via package metadata) so the installed package reports the correct version.

[Copilot]

Importing __version__ from a generated module can make import wordguess fail in contexts where the version file hasn’t been generated yet (e.g., source checkouts/editable installs if the file isn’t committed). Consider using importlib.metadata.version("wordguess") (with a safe fallback) or ensure the version module is always present in source distributions.

Suggested change

	from .__version__ import __version__
	try:
	from importlib.metadata import PackageNotFoundError, version
	except ImportError:
	# Fallback for very old Python versions without importlib.metadata
	__version__ = "0.0.0"
	else:
	try:
	__version__ = version("wordguess")
	except PackageNotFoundError:
	__version__ = "0.0.0"

[Copilot]

The docstring type for result was broadened to list, but the function signature is result: list[str] and the implementation requires a list of strings. Align the docstring with the actual expected type (e.g., “list[str]” / “list of str”) and tighten the wording (“list of result strings”).

Suggested change

	result : list
	A list containing the list of result. The result is a string
	with characters '0', '1', and '2' representing different guess outcomes.
	result : list[str]
	A list of result strings. Each string contains
	characters '0', '1', and '2' representing different guess outcomes.

[Copilot]

The Codecov upload step unconditionally references secrets.CODECOV_TOKEN, which is unavailable on PRs from forks and can cause CI failures. Gate this step behind a condition (e.g., only run when the secret is present / when the PR is from the same repo), or use tokenless uploads if the repository is public and supported by your Codecov setup.

[Copilot]

This workflow runs on pull_request while granting write permissions (contents: write, deployments: write) and executing PR-controlled code (pip install -e .[docs], quartodoc build, quarto render). That combination is risky because a malicious change in the PR could abuse the write-scoped GITHUB_TOKEN. Reduce default permissions to read-only and/or gate the deployment steps so they only run for same-repo PRs (not forks), or move the deployment portion to a safer event/approach (e.g., restricted workflow_dispatch or a carefully-audited pull_request_target + artifact flow).

Suggested change

	runs-on: ubuntu-latest
	permissions:
	contents: write
	if: github.event_name == 'workflow_dispatch' || github.event.pull_request.head.repo.full_name == github.repository
	runs-on: ubuntu-latest
	permissions:
	contents: read

[Copilot]

This statement is unreachable.

Suggested change

	TYPE_CHECKING = False
	if TYPE_CHECKING:
	from typing import Tuple
	from typing import Union
	VERSION_TUPLE = Tuple[Union[int, str], ...]
	COMMIT_ID = Union[str, None]
	else:
	VERSION_TUPLE = object
	COMMIT_ID = object
	from typing import Tuple
	from typing import Union
	VERSION_TUPLE = Tuple[Union[int, str], ...]
	COMMIT_ID = Union[str, None]