Skip to content

Update README.md #379

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+1 −1
Open

Update README.md #379

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion rebase-interactive-autosquash/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ There is a way to easily fix it with advanced options for `git commit` and `git

1. Explore the repo and the history so you know when the documentation file was added.
2. Fix `README.md` file and add it.
3. Add your commit by using `git commit --fixup=<commit id to be fixed>`.
3. Add your commit by using `git commit --fixup=<commit id to be fixed>`or use just git commit --fixup= commit id.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix invalid --fixup example and formatting

git commit accepts either --fixup=<commit> (no space after =) or --fixup <commit> (space, no =).
The newly-added variant --fixup= commit id is syntactically wrong and will throw “option requires an argument”.
It also lacks back-ticks and a space after the closing back-tick of the first example.

-3. Add your commit by using `git commit --fixup=<commit id to be fixed>`or use just git commit --fixup= commit id.
+3. Add your commit by using `git commit --fixup=<commit-id-to-be-fixed>` or `git commit --fixup <commit-id-to-be-fixed>`.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
3. Add your commit by using `git commit --fixup=<commit id to be fixed>`or use just git commit --fixup= commit id.
3. Add your commit by using `git commit --fixup=<commit-id-to-be-fixed>` or `git commit --fixup <commit-id-to-be-fixed>`.
🤖 Prompt for AI Agents 
In rebase-interactive-autosquash/README.md at line 19, fix the example usage of
git commit --fixup by removing the space after the equals sign in
--fixup=<commit id> and add a correct alternative with a space but no equals
sign as --fixup <commit id>. Also, add missing back-ticks around the commands
and ensure there is a space after the closing back-tick of the first example for
proper formatting.

4. Use `git rebase --autosquash --interactive v0.0` to view the rebase recipe automatically generated.
5. Use `git log` to view your new beautiful history.

Expand Down