Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

QA: Move CSVs into GitHub #30649

Open
4 tasks done
bryanboza opened this issue Nov 13, 2024 · 1 comment · Fixed by #30651
Open
4 tasks done

QA: Move CSVs into GitHub #30649

bryanboza opened this issue Nov 13, 2024 · 1 comment · Fixed by #30651

Comments

@bryanboza
Copy link
Member

bryanboza commented Nov 13, 2024

Task

The project’s CSV files are currently not stored in GitHub, making it difficult to understand their roles, purposes, and handling requirements when they are absent. This can lead to confusion and potential errors, especially if a CSV file is missing or if a new team member needs to understand the data structure quickly. By moving these CSVs into the repository with a clear README, we can enhance organization, improve accessibility, and provide guidance on the purpose of each file and instructions for handling missing files.

Tasks:

  • Organize CSV Files:

  • Create a dedicated folder in the repository (e.g., data/ or csv-files/) to store all CSV files.

  • Create a README:

  • Write a README.md file within the CSV folder to provide a description of each CSV file, including:

Purpose: A brief explanation of the file’s role.
Usage: Which components or modules use this file.

Add Instructions for Absence:

What actions to take if a file is missing, such as restoring from a backup, generating default data, or notifying team members.

Proposed Objective

Quality Assurance

Proposed Priority

Priority 2 - Important

@bryanboza
Copy link
Member Author

Done in PR: #30651

@spbolton spbolton linked a pull request Nov 14, 2024 that will close this issue
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: New
Development

Successfully merging a pull request may close this issue.

1 participant