RStudio README.Rmd 和 README.md 都应该分阶段使用“git commit --no-verify”来覆盖此检查

Question

我正在使用 RStudio，其中有 README.Rmd 和 README.md 文件。但是，当我只更改 README.Rmd 并想要提交并将其推送到 GIT 时，我得到以下信息：

RStudio README.Rmd 和 README.md 都应该分阶段使用“git commit --no-verify”来覆盖此检查

我应该在哪里添加：“git commit --no-verify”？

和/或我怎样才能避免这个消息？

Answer 1

遇到这个问题的人可能想看看该usethis软件包的相关问题中的争论。

简而言之，这是由 using 引起的usethis::use_readme_rmd()，它在 中设置了预提交挂钩.git/hooks/pre-commit。该钩子确保readme.Rmd和readme.md同时更新。如果只有一项发生更改，则会出现此问题标题中包含的错误消息。

例如，如果您的自述文件包含一些可以在项目更新时重建的摘要统计信息或一些随机数据，这可能会很烦人。

临时解决方案是按照消息所述进行操作，即转到终端并键入：

git commit --no-verify -m "my commit message"

如果您想完全摆脱这种行为，您应该删除该.git/hooks/pre-commit文件。

从 R 控制台，您可以通过以下方式实现此目的：

file.remove(".git/hooks/pre-commit")

Answer 2

当您编辑README.Rmd文件时，您的README.md文件不会自动同步。由于 GitHub 将显示您的README.md（而不是您的文件），因此在将文件推送到 GitHub 之前README.Rmd会检查您是否已构建文件。README.md不这样做将阻止您在README.Rmd文件中所做的任何更改出现在存储库中。

我建议始终使用以下工作流程：

1. 编辑你的README.Rmd文件
2. README.md通过devtools::build_readme()在 R 控制台中运行来构建文件
3. 提交您的README.Rmd和README.md

这样做不会引发任何警告，一切都会按照您可能想要的方式进行。