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

Fixed readme heuristic #55

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fixed readme heuristic #55

wants to merge 1 commit into from

Conversation

ntlhui
Copy link
Contributor

@ntlhui ntlhui commented Jun 10, 2023

Allowing additional dataset scope files.

@ntlhui ntlhui linked an issue Jun 10, 2023 that may be closed by this pull request
@ntlhui ntlhui self-assigned this Jun 10, 2023
@ntlhui ntlhui requested review from ccrutchf and a8ghosh June 10, 2023 22:52
@a8ghosh
Copy link

a8ghosh commented Jun 11, 2023

The edits do what they're supposed to, but I'm not entirely convinced it's a good idea. Having multiple readmes would make it confusing for people looking at the data later on. It might be worth asking/requiring uploaders to add descriptions on their file names if it's a separate extension. Opening up a dataset and seeing 'readme.md, readme.pptx, readme.png' would be confusing after all.

On the other hand, if the descriptions were there, it could be systemOutline.png and MathworksSymposiumPresentationSP23.pptx. The naming conventions could be hammered out later on, and we can still require them to name files using "readme-FileDescription-.ext", but I think it could be a worthwhile change to make. Though if this isn't a requirement we want to make, then I can approve the PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

bad readme heuristics
2 participants