Add CSV header requirements and examples to README#2
Open
Conversation
Co-authored-by: amenocal <6096355+amenocal@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Provide an example of the headers needed in the CSV
Add CSV header requirements and examples to README
Jul 10, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds comprehensive documentation for the CSV format requirements that users need to follow when uploading data to the GitHub Stats Visualizer.
Changes Made
Added a new "CSV Format Requirements" section to the README that includes:
Complete list of required headers - All 27 required CSV columns with exact naming:
Detailed header descriptions table - Explaining the data type and purpose of each field (string, number, boolean, ISO 8601 timestamps, etc.)
Sample CSV row - A realistic example showing proper data format with actual values
Important notes - Clarifying that all headers must be present for successful parsing
Validation
generateTestDatautilityScreenshot
The updated documentation now provides users with everything they need to prepare their GitHub repository data for upload and analysis:
This resolves the issue where users didn't know what CSV headers were expected by the application, eliminating parsing errors and improving the user experience.
Fixes #1.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.