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.

Sign up for GitHub

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

Jump to bottom

Structure of whole repository #123

Open
mirror-kt opened this issue Jul 10, 2020 · 10 comments
Open

Structure of whole repository #123

mirror-kt opened this issue Jul 10, 2020 · 10 comments

Comments

@mirror-kt
Copy link
Contributor

リポジトリ全体のディレクトリ・ファイル構成について
This was referenced Jul 10, 2020
Closed
Open
@mirror-kt
Copy link
Contributor Author

言語の名称のディレクトリ配下に、ソースコードと実行に必要なファイルを配置する
ことが提案されています

@mirror-kt
Copy link
Contributor Author

私個人としては、このリポジトリはあくまでソースコードのコレクションであり、必ずしもIDEなどで読み込んでそのまま実行できる必要はないと考えています。
実行に必要な条件はコメント等で提示すれば良いのではないか、ということです。

逆に、ソースコード以外のファイルが存在することを前提とする場合には、言語ごとのディレクトリを掘ってその中に入れ、そのディレクトリ内にその言語での実装を解説するREADMEを置くのもありだと思います。、

@siketyan siketyan changed the title Structure of whole of repository Structure of whole repository Jul 10, 2020
@siketyan
Copy link
Member

siketyan commented Jul 10, 2020 •
edited

ソースコード直置きを推していきます
いろんな拡張子が並んでたらおもしろくないですか

@raiga0310
Copy link
Sponsor Contributor

raiga0310 commented Jul 10, 2020 •
edited

Agree with @mirror-kt

@laminne
Copy link
Member

laminne commented Jul 11, 2020

各言語ごとにREADMEはあってもいいかもしれないですね

@mirror-kt
Copy link
Contributor Author

個人の感想ではあくまでこのリポジトリはコードを集めてるだけで、このリポジトリ上で直接実行やコードの修正を行う想定ではなかった気がします...
まずはここの前提を確認した方がいい気がしますね
@approvers/all

@soshiharami
Copy link
Sponsor Member

私の見解ではコードを見て楽しむ？レポジトリだと思っているので、いろんな拡張子が並んでいて、ぱっとコードが見れたほうがいいと思っています。
サブディレクトリ内にREADMEを作成するのはありだと思います。

@laminne
Copy link
Member

laminne commented Jul 13, 2020

ブランチを分離させてmasterは現在通り、別のブランチではサブディレクトリに分けるという折衷案もあるかもしれません

@mirror-kt
Copy link
Contributor Author

ブランチを分離させてmasterは現在通り、別のブランチではサブディレクトリに分けるという折衷案もあるかもしれません

言語が増えるたびに両ブランチをごにょごにょする手間が増えてしまうのでこれはちょっと微妙かもしれないです
両ブランチ間に親子関係ができなくなるのでそれぞれにコミットする必要が…

@0918nobita
Copy link
Contributor

0918nobita commented Jul 14, 2020 •
edited

無理に単一のソースファイルでコミットさせるメリットもあんまりない気がしてきました…

単にソースコードが並んでいるのを見て楽しむために始まったプロジェクトだということは理解していますが、
正直拡張子だけ見たところで何の言語で書かれてるか分かりづらい(いちいち中身のコメントを確認するのも面倒)ですし、
このままだとプログラムを読みたい人も、動かしたい人も、書きたい人も不便を強いられる状態だと思います。

やっぱり言語ごとにディレクトリを作ることだけをルールとして、
あとは個々のディレクトリで良しなに設定ファイル・.gitignore・README等を配置してもらうのが、
レビューする側・言語一覧を作成する側に対しても合理的で良いと思います。
※ 揉め事の原因を作った僕に意見の一貫性がないのは本当に申し訳ないです

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
6 participants
@0918nobita @siketyan @laminne @mirror-kt @raiga0310 @soshiharami