Skip to content

README_ISSUES.md

Latest commit

 

History

History
143 lines (104 loc) · 3.21 KB

README_ISSUES.md

File metadata and controls

143 lines (104 loc) · 3.21 KB
Raw

GitHub Issues Management Tools

This repository contains tools for managing and searching through all GitHub issues from the haxtheweb/issues repository.

Quick Stats

  • Total Issues: 2,418 (as of last fetch)
  • Open Issues: 226
  • Closed Issues: 2,192
  • Issue Range: #1 to #2422

Tools Available

1. fetch_issues.sh - Issue Data Fetcher

Downloads all GitHub issues and saves them locally for fast searching.

./fetch_issues.sh

Features:

  • Fetches all issues (open and closed) with full text
  • Saves data as JSON with complete metadata
  • Creates human-readable summary
  • Handles GitHub API limitations gracefully
  • Creates symlink to latest data for easy access

Output Files:

  • issues_data/all_issues_TIMESTAMP.json - Raw JSON data
  • issues_data/latest_issues.json - Symlink to most recent data
  • issues_data/issues_summary_TIMESTAMP.md - Human-readable summary

2. query_issues.sh - Issue Search Tool

Query and search through locally cached issues.

# Show statistics
./query_issues.sh stats

# Search by keyword
./query_issues.sh search "web component"

# Find specific issue
./query_issues.sh number 2422

# Filter by state
./query_issues.sh state open
./query_issues.sh state closed

# Filter by author
./query_issues.sh author btopro

# Show recent issues
./query_issues.sh recent 20

# List all labels
./query_issues.sh labels

# Filter by label
./query_issues.sh label bug

Data Structure

Each issue contains:

  • number - Issue number
  • title - Issue title
  • body - Full issue description/body text
  • state - "OPEN" or "CLOSED"
  • author - Author information
  • createdAt/updatedAt - Timestamps
  • labels - Array of labels
  • assignees - Array of assignees
  • url - GitHub URL

File Exclusions

The following files are gitignored to prevent accidentally committing large data files:

  • issues_data/ directory
  • *.issues.json files
  • all_issues*.json files
  • issue_cache*.json files

Usage Examples

Finding Issues About Specific Topics

# Find accessibility issues
./query_issues.sh search "accessibility"

# Find HAXcms-related issues
./query_issues.sh label HAXcms

# Find recent bugs
./query_issues.sh label bug | head -20

Research & Analysis

# Get overview of issue activity
./query_issues.sh stats

# See what specific author has worked on
./query_issues.sh author nikkimk

# Find open enhancement requests
./query_issues.sh label enhancement

Keeping Data Current

Run the fetch script periodically to update your local cache:

# Update issue data
./fetch_issues.sh

# The script will create new timestamped files and update the symlink

Performance Notes

  • Initial fetch takes ~30 seconds for 2400+ issues
  • Local searches are nearly instantaneous
  • All issue text is included for full-text search capabilities
  • Data is stored efficiently as JSON for fast processing with jq

Top Contributors

  1. btopro - 2,017 issues (83.4%)
  2. nikkimk - 75 issues
  3. Peter12G - 45 issues
  4. rickhumphries - 37 issues
  5. WilliamMRose - 24 issues

Most Common Labels

  1. bug - 438 issues
  2. enhancement - 388 issues
  3. HAXcms - 326 issues
  4. HAX editor - 322 issues
  5. UX - 296 issues