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.

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

Move doc/NEWS* to top level directory #780

Merged
merged 1 commit into from
May 28, 2017
Merged

Move doc/NEWS* to top level directory #780

merged 1 commit into from
May 28, 2017

Conversation

hanachin
Copy link
Contributor

NEWSがdocの下にあると見つけづらいので、Keep a CHANGELOGを参考にリネームしてトップディレクトリに移動しました。

What should the change log file be named?
Well, if you can’t tell from the example above, CHANGELOG.md is the best convention so far.

Some projects also use HISTORY.txt, HISTORY.md, History.md, NEWS.txt, NEWS.md, News.txt, RELEASES.txt, RELEASE.md, releases.md, etc.

It’s a mess. All these names only makes it harder for people to find it.
http://keepachangelog.com/en/0.3.0/

@kdmsnr
Copy link
Collaborator

kdmsnr commented May 26, 2017

移動はよいと思うのですが、すでにChangeLogがあるのでリネームは別に議論したいところです

@hanachin
Copy link
Contributor Author

確かに既にChangeLogがあるので大文字のCHANGELOG.mdが増えても混乱するかもしれませんね。リネームはやめてファイルの移動だけのコミットに変更してforce pushしようと思います。

@hanachin hanachin changed the title Rename doc/NEWS* to CHANGELOG* Move doc/NEWS* to top level directory May 26, 2017
@hanachin
Copy link
Contributor Author

移動だけに修正しました。

@kmuto
Copy link
Owner

kmuto commented May 26, 2017

そういえばChangeLogはもうメンテできないのでやめたいところなのですが、git logからでは歴史を追えない時代の記録物として消すのもどうかという悩みがあります。
ほかのChangeLogをあきらめたプロジェクトではどうしてるんですかね……。

@takahashim
Copy link
Collaborator

@kmuto Rubyの場合、古いChangeLogはdoc/ChangeLog-XXX_to_YYY というファイルにrenameして置いておく、というルールになっているようです(まだあきらめずに最新版はroot直下に置いてありますが)。

@kmuto
Copy link
Owner

kmuto commented May 28, 2017

@takahashim その形で古いChangeLogはリネームしてdoc/に保持、以降はChangeLogはメンテしない でよいかなと思います。

@takahashim
Copy link
Collaborator

NEWSに関しては、appveyorはfailしてますが、たぶんrubocopのせいで、rubocop修正後のtravis再実行結果はsuccessしているようなので(appveyorは私の権限では再実行できない)、これはこれで取り込みます

@takahashim takahashim merged commit e515c00 into kmuto:master May 28, 2017
@hanachin hanachin deleted the rename_news_to_changelog branch May 28, 2017 02:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants