docs: update README and example config with first-time setup instructions #822
+4
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
在 fork 项目本地开发中，直接修改
config/config.yaml文件是很常见且方便的做法，但问题在于容易将包含敏感信息的config.yaml错误提交到 repo 中，造成数据泄露。本 PR 主要进行了如下两项修复：
config/config.example.yaml替换config/config.yaml，并一同修改了 README 中关于config.yaml使用的说明.gitignore文件，忽略config/config.yaml文件的变更，让操作变得更安全