Rework folders structure

eficode-academy / git-katas

A set of exercises for deliberate Git Practice

MIT License

1.32k stars 860 forks source link

Rework folders structure #218

Closed alxb5 closed 4 years ago

alxb5 commented 4 years ago

I propose a PR to improve the files organization in the project.

With all katas in a dedicated folder we will be able to provide powerful utils to setup exercises in an easy way by avoiding duplicate code in setup.sh / setup.ps files.

I have re-linked (to follow the new structure):

[x] all documentation links
[x] all setup scripts (bash + powershell) to use scripts in utils folder
[x] tests to use scripts in utils folder

If it looks good to you, do not hesitate to merge all opened PR on the project and I will rebase this PR to minimize impacts.

RandomSort commented 4 years ago

Hi - I am unsure how this change enables utilities more than we currently already do?

RandomSort commented 4 years ago

Hi @alxb5, do you have any elaborations to my above question? :)

alxb5 commented 4 years ago

Hi @RandomSort, sorry for the delay I was out for a week :)

First of all, all katas in an unique folder could help anybody to enter in the project.

Then, if all katas are in the same folder we can imagine using new tool such as Makefile (still need to check on windows if it can be used) to browse katas folder and list all existing exercices with metadata for examples. Same for the setup we can imagine having a common script for all katas and just specify some commands instead of duplicating code in the setup.sh files.

The main idea here is to structure the project, then use some templates for README and setup.sh files.

Is it clear enough ?

RandomSort commented 4 years ago

I do not see how putting everything in an additional sub-folder actually enables anything. I like the idea of being able to have more tooling - and a one-off script setting everything up for a set of katas might also be good.

We still need to be able to reset individual katas. That is a powerful capability. And necessary. I am leaning towards rejecting this as churn. I love the idea of creating a template kata :)

I will drag in @sofusalbertsen and @JKrag as bearers of opinions :)

RandomSort commented 4 years ago

I will close this pull request - create an issue for this discussion if you feel there is something more to be gained from this :)