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

Move submodules into subdirectories #15

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Conversation

jayqi
Copy link
Member

@jayqi jayqi commented Sep 9, 2023

I propose we move all competition submodules a subdirectory.

  • This makes the repo home page look a lot better, and a user can more reasonably get to the README
  • Clicking on a submodule to visit the individual competition repository is strictly worse than using the links in the README's table, because the submodules link you to a specific commit instead of the repo's home page/default branch.

I also propose we retire the drivendataorg/for-fun-competitions repo, which itself contains submodules, and just directly add those submodules to this repo in a practice-competitions subdirectory. It feels like an unnecessary layer.

See this link for how it will look: https://github.com/drivendataorg/competition-winners/tree/jyq-subdir-reorg

@ejm714
Copy link
Contributor

ejm714 commented Sep 11, 2023

I'm good with this change though don't have strong opinions either way.

This makes the repo home page look a lot better, and a user can more reasonably get to the README

I would typically click on the submodule link directly rather than scrolling to the readme but I agree that as a general practice we should direct people to the readme.

Clicking on a submodule to visit the individual competition repository is strictly worse than using the links in the README's table, because the submodules link you to a specific commit instead of the repo's home page/default branch.

I'm not convinced that in practice we were having issues with these two pathways being out of sync, but I agree that it's nice to link to the default branch.

I also propose we retire the drivendataorg/for-fun-competitions repo, which itself contains submodules, and just directly add those submodules to this repo in a practice-competitions subdirectory. It feels like and unnecessary layer.

Strong agree

Additional thoughts:

  • Do we want to use "just for fun competitions" and "prize competitions" as the categories vs. "competitions" and "practice competitions"? We may want to mimic the latest language from the site redesign.
  • Should we alphabetize the links table to make it easier to navigate? Currently it's chronological but that likely has less meaning when separated from the competition site.

@jayqi
Copy link
Member Author

jayqi commented Sep 12, 2023

I'm not convinced that in practice we were having issues with these two pathways being out of sync, but I agree that it's nice to link to the default branch.

This is annoying, for example, if you use it to copy links—there were lots of competition results pages (mostly older ones) that had the commit-specific link instead of the repo default branch. (I have since replaced these.) This meant that viewers going through the results page would end up on a fixed older state of the repo instead of the most up-to-date version.

It's also annoying if you go to the repo with the intent to open up the web editor to edit something, which would put you at a detached commit instead of on the main branch.

Do we want to use "just for fun competitions" and "prize competitions" as the categories vs. "competitions" and "practice competitions"? We may want to mimic the latest language from the site redesign.

I actually intentionally renamed this to "practice competitions" to better match the redesign terminology. Not a strong preference on "competition" vs. "prize competition" though.

Screenshot 2023-09-11 at 11 10 19 PM

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.

2 participants