Skip to content

chore: add .vscode/ to gitignore (from #24)#40

Open
jguice wants to merge 2 commits into
mainfrom
chore/gitignore-vscode-from-pr-24
Open

chore: add .vscode/ to gitignore (from #24)#40
jguice wants to merge 2 commits into
mainfrom
chore/gitignore-vscode-from-pr-24

Conversation

@jguice
Copy link
Copy Markdown
Contributor

@jguice jguice commented Jan 10, 2026

Summary

This PR incorporates contributions from #24 — thank you @djtjwillia!

What's included

  • ✅ Added .vscode/ to .gitignore to prevent IDE workspace files from being committed
  • ✅ Improved uv installation instructions in README with direct link to installation docs and brew install uv command

Updated README line

README.md line 48

Prerequisite: uvx comes from uv. Use brew install uv on macOS & Linux.

@djtjwillia — we've incorporated both your gitignore addition and the more hand-holdy uv installation instructions. Let us know if this looks good or if you'd like any adjustments!


Closes #24

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation

    • Updated prerequisite guidance with clearer installation instructions and platform-specific recommendations.
  • Chores

    • Expanded IDE-specific file exclusions.

✏️ Tip: You can customize this high-level summary in your review settings.

Adds IDE workspace files to gitignore to prevent committing editor-specific configuration.

Credit to @djtjwillia from PR #24 for this contribution.

Co-Authored-By: Taylor Williams <taylorw@liatrio.com>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jan 10, 2026

📝 Walkthrough

Walkthrough

Updated repository docs and ignore rules: added .vscode/ to .gitignore and expanded README prerequisite to point to the uv installation page and recommend brew install uv for macOS and Linux.

Changes

Cohort / File(s) Summary
IDE Configuration Exclusions
.gitignore
Added an ignore rule for the .vscode/ directory and a separating blank line in the IDE-specific section.
Documentation — Prerequisites
README.md
Updated uv prerequisite link to the uv installation page and added recommendation to use brew install uv on macOS & Linux.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 A hop, a tweak, a tiny change,
I nudge the docs and hide a range.
.vscode tucked where it won't be seen,
uv's install tip? Brew keeps it clean.
Little rabbit, repo gleams. ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The pull request title clearly summarizes the main change: adding .vscode/ to gitignore. It is concise, specific, and directly reflects the primary modification in the changeset.
Description check ✅ Passed The description covers key aspects including motivation (incorporating contributions from #24), what changed (gitignore addition and README improvements), and includes details about the changes. It references the linked issue and includes a closing reference.
Linked Issues check ✅ Passed The pull request successfully addresses both primary coding objectives from issue #24: adding .vscode/ to .gitignore for IDE files and improving uv installation instructions in the README with brew command and direct documentation link.
Out of Scope Changes check ✅ Passed All changes in the pull request are directly aligned with the requirements in linked issue #24. The .gitignore modification and README update both address the stated objectives with no extraneous modifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9407a69 and 990feb2.

📒 Files selected for processing (1)
  • README.md
✅ Files skipped from review due to trivial changes (1)
  • README.md

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

- Link directly to uv installation docs instead of main page
- Add concrete `brew install uv` command for macOS & Linux

Credit to @djtjwillia from PR #24 for this improvement.

Co-Authored-By: Taylor Williams <taylorw@liatrio.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant