linux - 在使用 Git 提交之前检查代码中的注释以获取消息

Question

如果在本地开发时经常发现自己在代码中写下了有用的信息。将此代码片段视为一个简单示例:

# Public API
namespace :api do
  namespace :v1 do
    # REMOVE THE FIRST LINE WHEN DONE TESTING
    get :delivery_report, to: 'delivery_report#index'
    post :delivery_report, to: 'delivery_report#index'
  end
end

这里的 Gist 是，当我完成并且我觉得我终于可以提交我的工作时，我需要记住我必须删除行 get :delivery_report, to: 'delivery_report#index'

是否有可能以某种方式告诉 git 在接受提交之前或者可能在暂存提交之前，它应该警告我代码中包含某些内容的行？在这种情况下，这将是我的评论或任何其他预定义的行。

Answer 1

Git 支持“预提交 Hook ”，您可以在其中测试用户提议提交的内容，并在某些条件适用时强制提交失败。

参见 git pre-commit hook code formatting with partial commit?和 How do I properly git stash/pop in pre-commit hooks to get a clean working tree for tests?