Repo File Organization Initiative

[JasonUranta]

Overview

We need to organize and document the files in this repo so that we can use them after the people who have contributed have left.

Details

The purpose of this issue is to standardize the organization of files in the ai-skills-assessor repo so that scripts, data, tests, configuration files, and other information can all be located intuitively. This will improve maintainability, make onboarding easier for new contributors, and prepare the repo for automated testing and CI workflows.

Proposed File Structure Guidelines

• Scripts will generally be under the /scripts folder.
• Data will generally be under the /data folder.
• Tests will generally be under the /tests folder.
• Configuration files will generally be under the /config folder.

All other files will be sorted as needed.

Action Items

• Suggest Structure
• Identify all files
• Indicate file locations
• Write Summaries
• Reorganize file folders N/A

Resources/Instructions

[JasonUranta]

Files Contributed by @JasonUranta

The files currently contributed by @JasonUranta can be found under the following directories:

• ai-skills-assessor/data
• ai-skills-assessor/scripts
• .github/workflows

These files primarily address - #4

File Summaries

• Data
  • issue-comments.json:
    Machine-readable dataset of all fetched GitHub issue and PR comments, including metadata such as issue numbers, authors, timestamps, and reaction counts. This file is the core data source for analysis and visualization scripts.
  • issue-comments.md (Contingent on the merge of PR Added script to tally and analyze GitHub issue comments from JSON data #34):
    Markdown export of the same GitHub comment data, providing a readable, timestamped version for non-technical collaborators and documentation purposes.
• Scripts
  • fetch-issue-comments.py:
    Automates fetching GitHub issue and PR comments using the GitHub REST API. It handles pagination, rate limits, and ETags for efficient incremental syncing and writes both JSON and Markdown versions of the results.
  • tally-issue-comments.py (Contingent on the merge of PR Added script to tally and analyze GitHub issue comments from JSON data #34 ):
    Reads the fetched JSON data and tallies the number of comments per issue. It summarizes the total count, identifies the most-commented issue, and displays results in a formatted console table for reporting.
• Workflows
  • fetch-issue-comments.yaml:
    GitHub Actions workflow configuration that runs the fetch script automatically on schedule or manual trigger. It ensures the JSON and Markdown outputs remain current in the repo.

[sandy3w]

1. Progress: Organized my files according to the proposed structure + updated paths. Created PR#42 and added Jason and Andrew as reviewer
2. Blockers:
3. Availability:
4. ETA:
5. Pictures (if necessary):

[JasonUranta]

Asked

Instructions

1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
2. Blockers: "Difficulties or errors encountered."
3. Availability: "How much time will you have this week to work on this issue?"
4. ETA: "When do you expect this issue to be completed?"
5. Pictures (if necessary): "Add any pictures that will help illustrate what you are working on."

1. Progress: Got an idea of what the testing file suite should look like via a conversation with ChatGPT to answer the question "should all test be strictly under a test/ folder?" It gave a detailed answer highlighting to "structure tests along two axes at once: by test layer (unit → integration → e2e) and by domain (labels, fetchers, analytics/output)." Full ChatPT conversation and a sample test suite structure from ChatGPT are linked below.
2. Blockers: N/A
3. Availability: N/A
4. ETA: N/A
5. Pictures (if necessary):
   https://chatgpt.com/share/69095fea-7c68-800e-a826-f8f62943f475
   ai_skills_assessor_full_tests.zip