search

fivethirtyeight / data

Data and code behind the articles and graphics at FiveThirtyEight
https://data.fivethirtyeight.com/
Creative Commons Attribution 4.0 International
16.76k stars 10.95k forks source link

Suggestion on repo structure #8

Closed adamsb6 closed 7 years ago

adamsb6 commented 10 years ago

I see that you're grouping all data sets in one repo. While there's some convenience to organizing things that way, I think it's going to make it more difficult for curious readers to sort through once you've published hundreds of data sets. It would probably be better in the long term to do one repo for each story or data set, and then link to that individual repo from the story.

Given that there are only three data sets posted so far, this will be easier to re-organize now than later.

ascheink commented 10 years ago

Thanks for the suggestion.

nmpeterson commented 10 years ago

For what it's worth, I second this. If anyone wants to use the data/scripts themselves, they would currently have to fork the repository containing all data/scripts ever published by FiveThirtyEight. This will obviously become increasingly problematic as the number of articles grows.

alysbrooks commented 10 years ago

If you wanted to keep both individual repositories and an all-in-one repository, you could keep the readme up-to-date with links to the new datasets on Github and/or add the new datasets as submodules.

nmpeterson commented 10 years ago

One more humble suggestion: if you want to keep everything in a single repository, it may be worthwhile to begin all of the directory names with the publish date (in YYMMDD or YYYYMMDD format) so that they're sorted chronologically -- e.g. bob-ross would become 20140414-bob-ross or similar. I suspect the current naming convention (neither chronological nor an exact match with the article name) will prove frustrating for usability in the long run.

chaitanyagurrapu commented 10 years ago

+1 to this. It would be very useful when people want to make their own visualizations of the data etc.

Noctem commented 9 years ago

I had the same thought. And submodules, as @alecbrooks mentioned, would be a good way to have your cake and eat it too.

HollowDJ09 commented 7 years ago

I think that it would be easier for people who are trying to sort through the repositories if they were organised in a way that is similar to that of the website where they are put into categories or sub modules and then organized by alphabetical order.