Skip to content
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.

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

Add tutorial: Build Your Own Git With PHP #1383

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

Conversation

Omar-Ahmed-Elshiekh
Copy link

@Omar-Ahmed-Elshiekh Omar-Ahmed-Elshiekh commented Mar 10, 2025

A step-by-step guide to implementing a simplified version of Git’s core features like commits and managing directory structures in PHP.

Summary by CodeRabbit

  • Documentation
    • Expanded the resources by introducing a PHP guide for building Git, offering users access to an additional learning tool and broadening the range of programming languages represented.

Copy link

coderabbitai bot commented Mar 10, 2025

Walkthrough

The pull request updates the README.md file by adding a new resource entry in the "Build your own Git" section. The new entry introduces a PHP resource titled "Build & Learn Git with PHP" along with its URL. This update expands the diversity of programming language resources available for building Git.

Changes

File Change Summary
README.md Added a new PHP entry: * [**PHP**: _Build & Learn Git with PHP_](https://omar-ahmed-elshiekh.github.io/git-php-doc-website/) in the "Build your own Git" section

Poem

I'm a little rabbit, hopping with delight,
I saw a PHP entry shining so bright.
In the README garden, a new carrot appears,
Bringing fresh ideas to all our Git pioneers.
With twitching whiskers, I cheer this change today!
🐇🌟


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
🪧 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
README.md (1)

232-233: Use Consistent Emphasis Markers for Markdown Formatting

The newly added PHP resource entry currently uses underscores for italic emphasis (_Build & Learn Git with PHP_), but the project's markdown guidelines (as flagged by static analysis MD049) require asterisk-based emphasis. To ensure consistency, please update the entry to use asterisks.

-* [**PHP**: _Build & Learn Git with PHP_](https://omar-ahmed-elshiekh.github.io/git-php-doc-website/)
+* [**PHP**: *Build & Learn Git with PHP*](https://omar-ahmed-elshiekh.github.io/git-php-doc-website/)
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

232-232: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


232-232: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7b7d32b and c8bfb15.

📒 Files selected for processing (1)
  • README.md (1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md

232-232: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)


232-232: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)

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