私はnoob gitを使用しており、タグを作成して変更ログを生成/維持するためのベストプラクティスを知りたいです。
これまで、私は常にreadme.mdを作成し、(「変更ログ」のセクションで)最も重要な機能を手動で示していました。
例えば:
バージョン1.0.1
- 家のレイアウトを変更しました
- ギャラリーにスライドショーを追加
- 等..
これらの特性を備えた変更ログ(おそらくマークダウン形式)を作成するにはどうすればよいですか?
私はまだ明確な考えを持っていないので、提案は適切です
前もって感謝します :)
いくつかの一般的なガイドラインはまだありません。しかし、多くの優れたルールが変更ログを保持で説明されています。
そして彼らが言及するように:
友達にgitログを変更ログにダンプさせないでください。
そして、私はそれに完全に同意します。
そのため、これらすべてのガイドラインに従って変更ログを生成する GitHub Changelog Generator を作成しました。
実際にはGitHubのみで動作しますが、変更ログがどのように表示されるかを示す良い例です。
タグ、課題、ラベル、プルリクエストから変更ログを自動的に生成します。
例:この変更ログは次のスクリプトによって生成されました:CHANGELOG.md
変更ログ
1.2.5 (2015-01-15)
実装された拡張機能:
- マイルストーンを使用して、どのバージョンのバグが修正されたかを指定します #22
修正されたバグ:
- タグなしでリポジトリのログを生成しようとしたときにエラーが発生しました #32
マージされたプルリクエスト:
コマンドラインオプションを介してエンタープライズgithubをサポート #42 ( glenlovett )
変更ログに変更を手動で記述することをお勧めします。
タフなことに、githubdiffを介して生成された変更にリンクできます。たとえば、変更ログ: https://github.com/rspec/rspec-core/blob/master/Changelog.md
そしてdiff: https://github.com/rspec/rspec-core/compare/v2.14.2...master
多くの優れたプラクティスが見つかる他のいくつかの参照オープンソースプロジェクトのリポジトリを見て回ることができます。
おそらく私のAsnwerは手遅れですが、今は素晴らしいRuby gemを使用しています。これは、gitログを読み取り、タグで分割し、出力はマークダウンで書き込まれます。見てください。