docs: update README #23
Merged
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
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the README (English and Japanese) by documenting the new dry-run mode, adding the corresponding flag to the options table, and expanding the default ignore list.
- Added a dry-run usage example in both README.md and README_ja.md
- Introduced the
--dry-run, -dflag in the options table - Extended the ignore list with OS-specific, temporary, and VCS folders
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Added dry-run example snippet, option table entry, and expanded ignore list |
| README_ja.md | 同様のdry-run例、オプション表エントリ、および除外リストの拡張を追加 |
Comments suppressed due to low confidence (2)
README.md:165
- The example path includes a literal
HOMEdirectory segment in the source path which is likely unintended. It should reference the dotfiles folder directly, e.g.,/home/user/dotfiles/.config/git/config.
[o] [DRY-RUN] Would create file symlink: /home/user/.config/git/config -> /home/user/dotfiles/HOME/.config/git/config
README_ja.md:165
- 例示パスに誤って
HOMEディレクトリが含まれています。正しくは/home/user/dotfiles/.config/git/configのように、dotfilesディレクトリ直下を指すべきです。
[o] [DRY-RUN] Would create file symlink: /home/user/.config/git/config -> /home/user/dotfiles/HOME/.config/git/config
README.md
Outdated
| @@ -239,6 +253,9 @@ LICENSE | |||
| The following files and directories are automatically excluded: | |||
| - Directories starting with `.git` (like `.github`) | |||
| - Non-dotfiles in the root directory | |||
| - OS-specific files like `.DS_Store` (macOS) and `Thumbs.db` (Windows) | |||
| - Temporary files like `*.bak`, `*.tmp`, and vim swap files | |||
| - Version control system folders (`.git`, `.svn`, `.hg`) | |||
There was a problem hiding this comment.
[nitpick] The ignore list duplicates .git which is already covered by the first bullet (directories starting with .git). Consider merging or removing one entry to avoid redundancy.
Copilot uses AI. Check for mistakes.
README_ja.md
Outdated
Comment on lines
254
to
258
| - `.git` で始まるディレクトリ（`.github` など） | ||
| - ルートディレクトリの非ドットファイル（先頭が `.` でないファイル） | ||
| - OS固有のファイル（macOSの`.DS_Store`、Windowsの`Thumbs.db`など） | ||
| - 一時ファイル（`*.bak`、`*.tmp`、vimのスワップファイルなど） | ||
| - バージョン管理システムのフォルダ（`.git`、`.svn`、`.hg`） |
There was a problem hiding this comment.
[nitpick] 「.gitで始まるディレクトリ」との重複があります。冗長性を避けるため、項目を統合または一方を削除することを検討してください。
Suggested change
| - `.git` で始まるディレクトリ（`.github` など） | |
| - ルートディレクトリの非ドットファイル（先頭が `.` でないファイル） | |
| - OS固有のファイル（macOSの`.DS_Store`、Windowsの`Thumbs.db`など） | |
| - 一時ファイル（`*.bak`、`*.tmp`、vimのスワップファイルなど） | |
| - バージョン管理システムのフォルダ（`.git`、`.svn`、`.hg`） | |
| - `.git` で始まるディレクトリ（例: `.github`）およびバージョン管理システムのフォルダ（例: `.git`、`.svn`、`.hg`） | |
| - ルートディレクトリの非ドットファイル（先頭が `.` でないファイル） | |
| - OS固有のファイル（macOSの`.DS_Store`、Windowsの`Thumbs.db`など） | |
| - 一時ファイル（`*.bak`、`*.tmp`、vimのスワップファイルなど） |
Copilot uses AI. Check for mistakes.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.