Skip to content

Learning resource#2296

Merged
jcubic merged 3 commits into
mainfrom
learning-resource
Mar 16, 2026
Merged

Learning resource#2296
jcubic merged 3 commits into
mainfrom
learning-resource

Conversation

@jcubic

@jcubic jcubic commented Mar 16, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Member

I'm fixing a bug or typo

  • if this is your first time contributing, run npm run add-contributor and follow the prompts to add yourself to the README
  • squash merge the PR with commit message "fix: [Description of fix]"

I'm adding a parameter to an existing command X:

  • add parameter to the function in src/api/X.js (and src/commands/X.js if necessary)
  • document the parameter in the JSDoc comment above the function
  • add a test case in __tests__/test-X.js if possible
  • if this is your first time contributing, run npm run add-contributor and follow the prompts to add yourself to the README
  • read "Appendix A submodules" in the CONTRIBUTING.md document. Be sure to include submodule tests.

I'm adding a new command:

  • add as a new file in src/api (and src/commands if necessary)
  • add command to src/index.js
  • update __tests__/test-exports.js
  • create a test in src/__tests__
  • document the command with a JSDoc comment
  • add page to the Docs Sidebar website/sidebars.json
  • add page to the v1 Docs Sidebar website/versioned_sidebars/version-1.x-sidebars.json
  • if this is your first time contributing, run npm run add-contributor and follow the prompts to add yourself to the README
  • squash merge the PR with commit message "feat: Added 'X' command"
  • read "Appendix A submodules" in the CONTRIBUTING.md document. Be sure to include submodule tests.

Summary by CodeRabbit

  • Documentation
    • Added two new advanced video resources to the contributor guide: one on Git fundamentals (graphs, hashes, compression) and one featuring a technical talk on Git internals.
    • Updated contributor guide wording and formatting to present these as a grouped list of advanced videos for clearer discovery.

Copilot AI review requested due to automatic review settings March 16, 2026 18:07
@coderabbitai

coderabbitai Bot commented Mar 16, 2026 •
edited
Loading

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: d6758115-27ef-41a7-8353-8f2671312888

📥 Commits

Reviewing files that changed from the base of the PR and between 1723f19 and 5b67d4f.

📒 Files selected for processing (1)
  • CONTRIBUTING.md
📝 Walkthrough

Walkthrough

This change updates CONTRIBUTING.md: the singular "video" header is made plural and two advanced Git video entries (with thumbnails and links) are added; formatting adjusted with an extra blank line around the new entries.

Changes

Cohort / File(s) Summary
Documentation Resources
CONTRIBUTING.md		 Changed singular "video" header to plural and added two advanced Git video entries ("Advanced Git: Graphs, Hashes, and Compression, Oh My!" and "Git Internals by John Britton of GitHub - CS50 Tech Talk") with thumbnails/links; minor spacing adjustment.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested labels

released

Poem

🐰 Two videos hop into view,
Git graphs and internals too.
Thumbnails gleam, links in sight,
Contributors learn tonight. ✨📹

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Learning resource' is vague and generic, failing to convey the specific change being made to the CONTRIBUTING.md file. Consider a more descriptive title such as 'Add advanced Git learning resources to CONTRIBUTING.md' that clearly indicates what was added or changed.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
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.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch learning-resource
📝 Coding Plan
  • Generate coding plan for human review comments

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.

Tip

CodeRabbit can generate a title for your PR based on the changes.

Add @coderabbitai placeholder anywhere in the title of your PR and CodeRabbit will replace it with a title based on the changes in the PR. You can change the placeholder by changing the reviews.auto_title_placeholder setting.

Copilot AI reviewed Mar 16, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Updates the contributor documentation to include additional learning resources about Git internals for new contributors.

Changes:

  • Replaces the single “advanced video” reference with a small list of advanced Git videos.
  • Adds an additional Git internals talk link to the “How git works” section.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
coderabbitai[bot]
coderabbitai Bot reviewed Mar 16, 2026
View reviewed changes

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents 
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@CONTRIBUTING.md`:
- Line 94: Change the ungrammatical header string "And here are another advanced
videos:" to a correct phrasing such as "And here are some more advanced videos:"
(or "Here are other advanced videos:") in the CONTRIBUTING.md file so the
section header reads clearly and grammatically; update the exact text occurrence
"And here are another advanced videos:" to the chosen rewrite.
ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 92192678-72da-4264-a477-8145222ca6d6

📥 Commits

Reviewing files that changed from the base of the PR and between 7be8309 and 1723f19.

📒 Files selected for processing (1)
  • CONTRIBUTING.md

Comment thread CONTRIBUTING.md Outdated
@jcubic jcubic merged commit ecaf4d4 into main Mar 16, 2026
8 of 14 checks passed
@jcubic jcubic deleted the learning-resource branch March 16, 2026 18:41
@coderabbitai coderabbitai Bot mentioned this pull request Apr 6, 2026
Merged
17 tasks
@jcubic

jcubic commented Apr 6, 2026

Copy link
Copy Markdown
Member Author

🎉 This PR is included in version 1.37.5 🎉

The release is available on:

Your semantic-release bot 📦🚀

@jcubic jcubic added the released label Apr 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Copilot code review Copilot Copilot left review comments

Assignees

No one assigned

Labels

released

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@jcubic