Skip to content

Fix git add . on pre-commit hook#118

Merged
borfast merged 1 commit intomainfrom
improvement/dont-git-add-dot
Mar 18, 2025
Merged

Fix git add . on pre-commit hook#118
borfast merged 1 commit intomainfrom
improvement/dont-git-add-dot

Conversation

@borfast
Copy link
Copy Markdown
Contributor

@borfast borfast commented Mar 17, 2025

We have git add . in our git pre-commit hook but this has a big problem: it adds ALL changes in the working directory into the commit, whether they had been staged or not. This means that when someone has multiple changed / new files in the working directory, the commits end up with all those files in the commit, even if the user only intended for a couple of them to be there.

Instead, only files that were already staged, meaning explicitly added by the user, should be added by the hook. Git add has the -u flag for that.

Summary by CodeRabbit

Summary by CodeRabbit

  • Chores
    • Updated the commit staging process to include only modifications and deletions of existing files, reducing the chance of inadvertently adding new untracked files.

@borfast borfast requested review from emlimlf and gaspergrom March 17, 2025 23:25
@borfast borfast self-assigned this Mar 17, 2025
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 17, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request updates the Git pre-commit hook command. The hook now uses git add -u instead of git add ., ensuring that only modifications and deletions to already tracked files are staged. No changes were made to declarations of exported or public entities.

Changes

File Change Summary
frontend/…/pre-commit Updated the Git pre-commit hook command from git add . to git add -u to limit staging to tracked files.

Sequence Diagram(s)

sequenceDiagram
    participant Dev as Developer
    participant Hook as Pre-commit Hook
    participant Git as Git
    Dev->>Hook: Initiate commit
    Hook->>Git: Execute "git add -u"
    Git-->>Hook: Stage modifications and deletions (tracked files only)
    Hook->>Dev: Continue with commit process
Loading

Possibly related PRs

  • added husky #11: Introduces new logic in the pre-commit hook, directly relating to the changes in the staging command.

Suggested reviewers

  • gaspergrom

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
    - To enable this feature, set early_access to true under in the settings.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d7e3d02a74bfae3ebe7893b21b70c959e063beeb and bde64fb.

📒 Files selected for processing (1)
  • frontend/.husky/pre-commit (1 hunks)

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

"git add ." adds *ALL* changes in the working directory into the commit, whether they had been staged or not. This means the commit would end up with files the user may not have intended to be there. Instead, only files that were already staged should be added, which the -u flag provides.

Signed-off-by: Raúl Santos <4837+borfast@users.noreply.github.com>
@borfast borfast force-pushed the improvement/dont-git-add-dot branch from d7e3d02 to bde64fb Compare March 18, 2025 09:55
@borfast borfast merged commit 816166b into main Mar 18, 2025
2 of 3 checks passed
@borfast borfast deleted the improvement/dont-git-add-dot branch March 18, 2025 09:56
@borfast borfast assigned borfast and unassigned borfast May 2, 2025
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.

3 participants