I have a package on CRAN that I would like to add a ChangeLog for, but I cannot find information anywhere on how to do this.
我在CRAN上有一个包我想添加一个ChangeLog，但我无法在任何地方找到有关如何执行此操作的信息。
I looked on the "Writing R Extensions" document that CRAN provides, but it only mentions ChangeLogs and gives no direction (I could find) about how to create one.
我查看了CRAN提供的“Writing R Extensions”文档，但它只提到了ChangeLogs并且没有给出关于如何创建一个的指示（我可以找到）。
I noticed from downloading tarballs from other packages on CRAN (e.g. seacarb) that their ChangeLogs are Unix Executable Files (I'm on a Mac) so that's not too helpful.
我注意到从CRAN上的其他软件包下载tarball（例如seacarb），他们的ChangeLogs是Unix可执行文件（我在Mac上），所以这不太有帮助。
I imagine this is a common problem, but Googling "changelog R package" just brings up ChangeLogs for really popular packages...
我想这是一个常见的问题，但谷歌搜索“changelog R package”只是为真正流行的软件包带来了ChangeLogs ......
1 个解决方案
#1
19
You can either provide a NEWS file or a ChangeLog file, or both, to describe changes in your package. You have to add these files in the top level folder of your project, i.e. in the same folder as your DESCRIPTION and NAMESPACE.
您可以提供NEWS文件或ChangeLog文件，或两者都提供，以描述程序包中的更改。您必须将这些文件添加到项目的*文件夹中，即与DESCRIPTION和NAMESPACE在同一文件夹中。
This is documented in the R package manual in paragraph 1.1 Package structure. In particular, this paragraph points to the GNU standard:
这在1.1包装结构的R包手册中有记载。特别是，这一段指向GNU标准：
For the conventions for files NEWS and ChangeLog in the GNU project see http://www.gnu.org/prep/standards/standards.html#Documentation.
有关GNU项目中NEWS和ChangeLog文件的约定，请参阅http://www.gnu.org/prep/standards/standards.html#Documentation。
Hadley points out that "Generally you should use a NEWS file, and not ChangeLog. I think the purpose of ChangeLog (to list every change), has been subsumed by source code control".
Hadley指出“通常你应该使用一个NEWS文件，而不是ChangeLog。我认为ChangeLog的目的（列出每一个变化）已被源代码控制所包含”。
To create a NEWS file, simply create a text file called NEWS in the top level folder of your package. You maintain this file by hand.
要创建NEWS文件，只需在包的*文件夹中创建一个名为NEWS的文本文件。您手动维护此文件。
Here is an extract from the NEWS file from my package miniCRAN (CRAN link):
以下是我的包miniCRAN（CRAN链接）中NEWS文件的摘录：
miniCRAN v0.0-21 (Release date: 2014-08-18)
==============
Changes:
* Changes to defaults in plot.pkgDepGraph() to move legend to left of plot area.
miniCRAN v0.0-20 (Release date: 2014-08-18)
==============
Changes:
* Modified examples to reduce running time, mostly using \dontrun{} sections
#1
19
You can either provide a NEWS file or a ChangeLog file, or both, to describe changes in your package. You have to add these files in the top level folder of your project, i.e. in the same folder as your DESCRIPTION and NAMESPACE.
您可以提供NEWS文件或ChangeLog文件，或两者都提供，以描述程序包中的更改。您必须将这些文件添加到项目的*文件夹中，即与DESCRIPTION和NAMESPACE在同一文件夹中。
This is documented in the R package manual in paragraph 1.1 Package structure. In particular, this paragraph points to the GNU standard:
这在1.1包装结构的R包手册中有记载。特别是，这一段指向GNU标准：
For the conventions for files NEWS and ChangeLog in the GNU project see http://www.gnu.org/prep/standards/standards.html#Documentation.
有关GNU项目中NEWS和ChangeLog文件的约定，请参阅http://www.gnu.org/prep/standards/standards.html#Documentation。
Hadley points out that "Generally you should use a NEWS file, and not ChangeLog. I think the purpose of ChangeLog (to list every change), has been subsumed by source code control".
Hadley指出“通常你应该使用一个NEWS文件，而不是ChangeLog。我认为ChangeLog的目的（列出每一个变化）已被源代码控制所包含”。
To create a NEWS file, simply create a text file called NEWS in the top level folder of your package. You maintain this file by hand.
要创建NEWS文件，只需在包的*文件夹中创建一个名为NEWS的文本文件。您手动维护此文件。
Here is an extract from the NEWS file from my package miniCRAN (CRAN link):
以下是我的包miniCRAN（CRAN链接）中NEWS文件的摘录：
miniCRAN v0.0-21 (Release date: 2014-08-18)
==============
Changes:
* Changes to defaults in plot.pkgDepGraph() to move legend to left of plot area.
miniCRAN v0.0-20 (Release date: 2014-08-18)
==============
Changes:
* Modified examples to reduce running time, mostly using \dontrun{} sections