fix: code review improvements - docs, scripts, and tooling

.gitignore

@@ -15,3 +15,6 @@ weekly-report.md
 
 # Test outputs
 test-output/
+
+# Working directory for file staging
+.tmp/

CHANGELOG.md

@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Fixed
+- **Corrupted documentation**: Rewrote `docs/testing.md` to remove duplicated/interleaved content and restore a clean testing guide
+- **Corrupted tests README**: Rewrote `tests/README.md` to remove duplicated content and ensure it only references existing test files
+- **CLI error message**: Changed misleading `ERROR: GITHUB_OUTPUT environment variable not set!` to a debug message in CLI mode (GITHUB_OUTPUT is only relevant in GitHub Actions)
+- **Hyperlinks documentation**: Fixed `docs/hyperlinks.md` overview that incorrectly said "metrics greater than 1" when the actual behavior is "metrics greater than 0"
+
+### Changed
+- **CONTRIBUTING.md**: Updated from generic Python template (referenced `pip install`, `pytest`, PEP 8) to accurate shell-project instructions with correct tooling (`bash`, `curl`, `jq`) and test commands
+- **Argument parsing**: Removed no-op `shift` statements inside `for arg in "$@"` loop in `generate-report.sh` (shift has no effect inside a for loop)
+- **Copilot instructions**: Added `.tmp/` file staging guidelines to prevent heredoc/shell escaping issues
+- **`.gitignore`**: Added `.tmp/` working directory for file staging
+
 ## [2.2.0] - 2025-10-23
 
 ### Added

CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# Contributing to QuantEcon GitHub Actions
+# Contributing to QuantEcon Weekly Report Action
 
 Thank you for your interest in contributing! We welcome contributions from the community.
 
@@ -16,34 +16,55 @@ Thank you for your interest in contributing! We welcome contributions from the c
 
 ```bash
 # Clone your fork
-git clone https://github.com/YOUR-USERNAME/REPO-NAME.git
-cd REPO-NAME
+git clone https://github.com/YOUR-USERNAME/action-weekly-report.git
+cd action-weekly-report
 
-# Install development dependencies (if applicable)
-pip install -r requirements-dev.txt
+# Ensure dependencies are available
+# Required: bash, curl, jq, date
+brew install jq  # macOS
+# sudo apt-get install jq  # Linux
 
-# Run tests
-pytest tests/
+# Run basic validation tests (no token needed)
+./tests/test-basic.sh
+
+# Run with real data (requires GitHub token)
+export GITHUB_TOKEN=ghp_xxxxx
+./generate-report.sh --org=QuantEcon
+cat report.md
 ```
 
 ## Code Style
 
-- Follow PEP 8 for Python code
-- Use meaningful variable and function names
-- Add docstrings for functions and classes
-- Keep functions small and focused
+### Shell Scripts
+- Use `set -e` for error handling
+- Add comments for complex logic
+- Use descriptive variable names
+- Add function documentation
+- Include debug output for troubleshooting
+
+### Documentation
+- Use clear headings (H1, H2, H3)
+- Include code examples
+- Use proper markdown formatting
+- Keep tables concise and readable
+
+### Commit Messages
+- Use conventional commits: `feat:`, `fix:`, `docs:`, `test:`, `chore:`
+- Be specific and descriptive
+- Reference issues when applicable
 
 ## Testing
 
-- Write tests for new functionality
-- Ensure existing tests pass
-- Test with different Python versions if applicable
-- Include integration tests for the GitHub Action
+- Run `./tests/test-basic.sh` for syntax and structure validation
+- Run `./test-hyperlinks.sh` to test the hyperlink feature
+- Run `./tests/test-external-repos.sh` to test external repo format validation
+- For live testing: `./generate-report.sh --token=ghp_xxx --org=QuantEcon`
+- See [docs/testing.md](docs/testing.md) for the full testing guide
 
 ## Pull Request Process
 
 1. Update documentation if needed
-2. Add entries to CHANGELOG.md
+2. Add entries to CHANGELOG.md under `[Unreleased]`
 3. Ensure CI passes
 4. Request review from maintainers
 
@@ -54,7 +75,7 @@ When reporting issues, please include:
 - Clear description of the problem
 - Steps to reproduce
 - Expected vs actual behavior
-- Environment details (OS, Python version, etc.)
+- Environment details (OS, shell version, etc.)
 - Relevant logs or error messages
 
 ## Questions?

docs/hyperlinks.md

@@ -2,7 +2,7 @@
 
 ## Overview
 
-The weekly report now includes **clickable hyperlinks** for metrics greater than 1. When viewing the report in Markdown, clicking on a number will take you directly to the relevant GitHub page showing those specific items.
+The weekly report now includes **clickable hyperlinks** for metrics greater than 0. When viewing the report in Markdown, clicking on a number will take you directly to the relevant GitHub page showing those specific items.
 
 ## Feature Behavior