2016-12-20 6 views
2

私は自分のGitHubプロファイルに取り組んできた小さなプロジェクトを開発してアップロードしようとしています。これらのプロジェクトはお互いに依存していません。GitHubで小さなプロジェクトを整理して分類するには?

私の問題は、そのうちのいくつかは小さな単一ファイルプロジェクトだということです。私が解決したようなミニチャレンジのような並べ替え。だから私は、例えばPythonプログラミングと呼ばれる1つのリポジトリの下でそれらをグループ化することを考えています。

これは良い方法ですか?

  • はい、私はGitの中でそれについてどのように行く必要がある場合は、と はどのように私はまだ、それぞれのミニプロジェクトのために現れてREADMEファイルを持つことができます。

  • いいえ、何をお勧めしますか?

+1

Repoはあなたの個人的な使用のために必要なものであれば何でもかまいません。それらをフォルダに分けて、それぞれにReadmeが付属しています(たとえば、Gulpとマージできます)。チームや共同作業者は、自分の好みに応じて何かに変身させることができます。ハードなルールはありません。 – Nevertheless

答えて

2

GitHubはあなたが訪れるすべてのフォルダに対してREADMEファイルをレンダリングするので、1つのリポジトリだけを使用する場合、独自のREADMEファイルを持つことができる各 "サブプロジェクト"ごとに1つのサブフォルダを作成することになります。

しかし、そのルートに行く前に、それらの小さなプロジェクトが実際に一緒に属しているかどうかを考える必要があります。最終的には、それらをすべて同じリポジトリに入れるか、複数のリポジトリに分割するかを決定する必要があります。その決定のために考慮すべき

いくつかの点:プロジェクトは、別のに依存していない場合は

  • 、彼らはが別のを関連付けるまだやりますか?たとえば、これらのプロジェクトはProject Eulerのような大きなプログラミング上の課題の一部であり、すべてのソリューションを収集するだけですか?単一のリポジトリが理にかなっているかもしれません。
  • 個々のプロジェクトがより大きなものに成長するチャンスは何ですか?多くのことは非常に小さいものですが、最終的には自分のリポジトリを正当化する本当のものに成長します。その時点で、他の人たちに貢献させることさえあります。
  • これらの個々のファイルが履歴を共有することは意味がありますか?ファイルは "完了"したら編集されるでしょうか?私。これはちょうど完成したものの集合ですか、実際に進行中の実験ですか?

最終的には、あなたの個人的な選択になります。しかし、GitHubはリポジトリホスティング事業者として、あなたの意思決定を促すべきではありません。 Gitリポジトリをローカルに作成して、それが理にかなっているはずです。それはあなたがただ一つのものを持っているということを意味するならば、それはいいです。それはあなたがそれらの多くを作成することを意味する場合、それはまた良いです。

残念ながら、GitHub UIは実際には小さなオンリープロジェクトでは作成されません。リポジトリリストは、そのために組織化されていないだけです。小規模なプロジェクトを使用する場合は、GitHubプロファイル内にいくつかのプレフィックスを付けることをお勧めします。

ワンオフプロジェクトの良い選択肢は、特に単一の(または少数の)ファイルの場合は、Gistsです。 GISTはコードスニペットを共有する方法として生まれましたが、実際にはすべてのGistは完全なGitリポジトリです。もちろん、GitはGitHubのツールリポジトリを提供していません(例えばissue、pull要求、wiki)。しかし、あなたが言うことについては、おそらくそれらのどちらも必要ないでしょう。そして、あなたのプロフィールに完全なリポジトリを追加することなく簡単なことを分かち合う良い方法です。そして、それらをクローンしても(遠隔URLは[email protected]:/<gist-id>.git)、それらが必要な場合は、複数のファイルの完全な履歴とサポートを持つことができます。

+0

私はメカニカルエンジニアで実際には1年前に自分自身にソフトウェア開発を教えることにしました。私は仕事を探しているので、私の友人はすべてのプロジェクトをGitHubにポートフォリオとして置くことを勧めています。したがって、小規模なプロジェクトを整理することの頭痛。 しかし、あなたの答えは私に多くの明快さをもたらしました。乾杯! –

2

一般的に、あなたはレポのトップレベルは、READMEファイル、多分setup.pyおよび他のいくつかの無関係な情報、そしておそらくtestsフォルダが含まれていることがわかります。次に、レポと名前を共有するフォルダがあります。そのフォルダの中には、モジュール/パッケージ/スクリプトの中核となるコードがあります。

特に、単一ファイルスクリプトの非常に小さなプロジェクトでは、異なる組織を見るのは珍しいことではありません。

具体的なケースについては、好きなことをしてください。あなたが提案するものは、私にとって全く妥当なものです。私は解決したすべての課題に対して別々のレポを持つことを望んでいません!

私は通常、些細な項目にはgistを使用します。私は、コーディングの課題を含め、必ずしもレポを作りたいとは限りません。だから私はこれを代替案として提案します。あなたが一番好きなことをやってください。

関連する問題