search

exercism / meta

Experimenting with a repo to manage the project-wide, meta todos.
7 stars 2 forks source link

Rename repositories for the sake of readability and clarity #1

Closed kytrinyx closed 7 years ago

kytrinyx commented 7 years ago

Each language track should be named after the slug of the programming language—no 'x' prefix. The x-common repository should be named problem-specifications.

First test with one of the inactive tracks to see how Trackler handles it, and what happens with the x-api and the website. It needs to have at least one exercise.

UPDATE: Since renaming the track adds a redirect, the change is seamless.

See the discussion in https://github.com/exercism/discussions/issues/103

TODO

kytrinyx commented 7 years ago

@exercism/golang I'm going to rename the team to @exercism/go to match the track ID.

Update: we also have @exercism/perl which doesn't directly map to the track IDs of perl5 and perl6, and we have a number of @exercism/lisp tracks that don't have their own teams. I've suggested that we add teams for each track, and nest them under a parent team.

petertseng commented 7 years ago

and while we're at it don't forget that the https://github.com/orgs/exercism/teams/io team is confusingly not about the Io language, which will cause confusion when the Io language gets a track.

You can probably assume I'm joking and don't need to do anything with that team.

kytrinyx commented 7 years ago

You can probably assume I'm joking and don't need to do anything with that team.

I could probably assume that, but I'm going to be cleaning up team names, and will clean that one up too :)

kytrinyx commented 7 years ago

@exercism/xruby @exercism/ruby what's the difference between these two teams? Do they have different purposes? If so, can we rename them to clarify that (and also nest one under the other)?

kytrinyx commented 7 years ago

I did some digging and it turns out @exercism/xruby's members are a subset of @exercism/ruby's members. I'm going to delete the xruby team, as it doesn't seem to serve a direct purpose.

If you do see a separate purpose, let's talk about it in the discussions repository, and maybe we can make something consistent for all the tracks.

Insti commented 7 years ago

I've no idea why there is 2 ruby groups. Deleting xruby seems fine.

kytrinyx commented 7 years ago

I've run a script to make sure that all the track repositories have a team with push permissions that is named after the track ID. Where there are discrepancies I've @-mentioned the maintainers of the tracks in question to discuss.

kotp commented 7 years ago

Thanks @kytrinyx

kytrinyx commented 7 years ago

I've tested this with the VB.NET track, and the change was completely seamless.

arcuru commented 7 years ago

@kytrinyx FYI, it looks like renaming the repos breaks any stored urls to travis-ci. I think this only really affects the 'status' button that's in most (or all?) of the track README's.

kytrinyx commented 7 years ago

Ah, yepp--I will write a script to update that! Thanks for catching it @patricksjackson

petertseng commented 7 years ago

This is FYI only and no actions are necessary in response.

Respository names of the form e.g. exercism/haskell seem to make sense and be unambiguous given that someone knows what Exercism is. I was worried, however, that forking it to my own username as username/haskell might give the impression that I'm working on the entire language, or something of that sort. So I am forking to username/exercism-haskell instead.

/shrug

kotp commented 7 years ago

@petertseng this is also the reason I have not renamed the forks I have to plain language names, preferring the x prefix.

kytrinyx commented 7 years ago

I was worried, however, that forking it to my own username as username/haskell might give the impression that I'm working on the entire language, or something of that sort.

This didn't occur to me until I had already made the change. Under exercism/haskell it makes sense, when forked, less so.

So I am forking to username/exercism-haskell instead.

Is there a way to do that directly in the user interface?

/cc @exercism/julia

petertseng commented 7 years ago

So I am forking to username/exercism-haskell instead.

Is there a way to do that directly in the user interface?

Hmm, I appear not to have found one. I have to fork with the unqualified name and then rename it afterward.

kotp commented 7 years ago

This is a point that could be suggested in the reading. (Otherwise searching for language repositories in github could very well be a "pollution" caused by the Exercism project forks.) I don't think we want to be the cause of that for new folks, it is confusing enough as it is starting out.

yurrriq commented 7 years ago

We could include a shell snippet for forking to a different name. I know introducing more tooling is probably not ideal, but hub is good at this sort of thing.

tleen commented 7 years ago

Unless you are actually working on the language on GitHub is the issue here that it may be misleading?

NobbZ commented 7 years ago

As I am reading all these true and valid concerns... What will happen when user U (a contributor to language L) has already forked that languages repo under U/L does now fork exercism/L?

tleen commented 7 years ago

That seems to be the the issue: if you are working on the core language there is a naming conflict with the fork and its unresolvable via the GitHub UI as part of the working process: "You already have a fork of this repository:".

This may be a legit GitHub issue? That you can't fork two distinct repositories with the same name.

SaschaMann commented 7 years ago

What will happen when user U (a contributor to language L) has already forked that languages repo under U/L does now fork exercism/L?

The fork of exercism/L will be called U/L-1. Afterwards it can be renamed (https://github.com/exercism/julia/pull/68#issuecomment-309756496).

Renaming the repos to L-track might be nicer, it doesn't have the issues that just L has but it's not as arbitrary as xL.

tleen commented 7 years ago

GitHub lets you do it. So it's not on them. Make make sense to use a snippet then.

kytrinyx commented 7 years ago

I think that there are a couple of good options here:

or

catb0t commented 7 years ago

Will https://github.com/exercism/problem-specifications exist soon? It was mentioned in the original comment but it doesn't seem like anyone followed up on that.

kytrinyx commented 7 years ago

Oh! @catb0t I forgot about that one. I'll do it right now.

kytrinyx commented 7 years ago

Alright. We're done here. There are still a couple of PRs to be merged, but they're in repositories that are maintained.

Thanks y'all!