如何避免本地配置文件上传至GitHub同时保留示例文件？

方法一：用Git skip-worktree标记（推荐单开发者场景） #

这个方法能让Git彻底忽略本地配置文件的修改，同时保留远程仓库里的虚拟值版本：

• 先确保GitHub上的配置文件已经是虚拟值的干净版本，且已完成提交推送。
• 本地修改配置文件为真实敏感值后，在终端执行：

  git update-index --skip-worktree <你的配置文件名>
  

• 执行后，VS Code的Git面板里不会再显示这个文件的修改，提交时也不会包含它。
• 若之后需要更新远程的配置模板（比如新增配置项），先取消标记：

  git update-index --no-skip-worktree <你的配置文件名>
  

  修改成新的虚拟值，提交推送后，再重新执行skip-worktree命令恢复标记。

方法二：配置模板文件法（适合团队协作/长期维护） #

彻底隔离本地与远程的配置文件，避免任何冲突风险：

• 在仓库中创建配置模板文件，比如config.example.js（根据你的脚本类型命名），写入所有配置项的虚拟值，提交推送到GitHub。
• 本地复制模板文件为真实配置文件（比如config.js），替换成你的敏感信息。
• 将真实配置文件名添加到.gitignore中，确保Git完全不追踪它：

  # .gitignore内容
  config.js
  

• 在项目README里补充说明：请复制config.example.js为config.js，并替换为真实的API密钥等信息。

注意事项 #

• 不要用git update-index --assume-unchanged，这个标记是给Git优化用的（比如避免检查大文件），不适合本地修改不想提交的场景，skip-worktree才是专门干这个的。
• 可以用git ls-files -v | grep "^S"查看所有标记了skip-worktree的文件，避免遗忘标记。

内容的提问来源于stack exchange，提问作者Sacha00Z