Skip to content

Conversation

@orangci
Copy link
Contributor

@orangci orangci commented Sep 10, 2025

Fix various typos.

Additionally fix broken changelog link in the pull request template, as the default branch name was changed from main to master (I think).

Add a 👍 reaction to pull requests you find important.

Summary by CodeRabbit

  • Documentation

    • Clarified “nh search” description as powered by an ElasticSearch client and improved article usage.
    • Corrected typos in architecture and attribution sections for readability.
    • No code or API changes.
  • Chores

    • Updated the pull request template to point the changelog link to the correct branch.

a ElasticSearch -> an ElasticSearch
platfom -> platform
thee -> the
the default branch name was changed from main to master
@coderabbitai
Copy link

coderabbitai bot commented Sep 10, 2025

Note

Reviews paused

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Walkthrough

Updated the PR template changelog link from main to master; corrected two typos in the PR checklist. Edited README wording: clarified “nh search” as “powered by an Elasticsearch client”, removed duplicated phrasing, and fixed typos (“platfom”→“platform”, “thee”→“the”). No code or API changes.

Changes

Cohort / File(s) Summary
PR template edits
.github/PULL_REQUEST_TEMPLATE.md
Changed changelog link target from main to master; fixed checklist typos (“please bug” → “bug”, “docunentation” → “documentation”).
README documentation edits
README.md
Updated “nh search” description to “powered by an Elasticsearch client”; removed duplicated phrasing in usage text; fixed typos (“platfom” → “platform”, “thee” → “the”).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.


📜 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 77c5201 and 201eba5.

📒 Files selected for processing (2)
  • .github/PULL_REQUEST_TEMPLATE.md (2 hunks)
  • README.md (4 hunks)
✅ Files skipped from review due to trivial changes (1)
  • .github/PULL_REQUEST_TEMPLATE.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.md

Pre-merge checks (3 passed)

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title succinctly describes the core modifications by accurately highlighting the typo corrections and the broken link update in metadata files, aligning directly with the primary changes in the pull request.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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

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 (4)
.github/PULL_REQUEST_TEMPLATE.md (2)

4-8: Fix grammar: “please bug”.

Suggest correcting the sentence.

-of the added plugin or dependency in this section. If your pull request aims to
-fix an open issue or a please bug, please also link the relevant issue below this
+of the added plugin or dependency in this section. If your pull request aims to
+fix an open issue or a bug, please also link the relevant issue below this

30-31: Typo: “docunentation” → “documentation”.

-  - [ ] I have added appropriate docunentation to new code
+  - [ ] I have added appropriate documentation to new code
README.md (2)

86-87: Brand style: “Elasticsearch”, not “ElasticSearch”.

Official spelling is “Elasticsearch” (single word, lowercase “s”). Recommend:

-- `nh search` - a super-fast package searching tool (powered by an ElasticSearch
+- `nh search` - a super-fast package searching tool (powered by an Elasticsearch

(elastic.co)


144-145: Minor style: duplicated “today”.

-You can try NH today in a Nix shell today, no setup required!
+You can try NH in a Nix shell today, no setup required!
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 440d3a6 and 77c5201.

📒 Files selected for processing (2)
  • .github/PULL_REQUEST_TEMPLATE.md (1 hunks)
  • README.md (3 hunks)
🔇 Additional comments (3)
.github/PULL_REQUEST_TEMPLATE.md (1)

23-23: Changelog link target looks correct.

Default branch is currently “master” and CHANGELOG.md exists at repo root, so this URL should resolve as intended. (github.com)

README.md (2)

278-279: LGTM — typo fixed.

“platfom” → “platform” is correct.


296-301: LGTM — wording fix.

“thee” → “the” reads correctly.

@NotAShelf
Copy link
Member

My beloved proofreader is back...

@NotAShelf
Copy link
Member

@coderabbitai ignore

@coderabbitai
Copy link

coderabbitai bot commented Sep 10, 2025

✅ Actions performed

Reviews paused.

Copy link
Member

@NotAShelf NotAShelf left a comment

Choose a reason for hiding this comment

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

Ain't no bot gonna review my favorite proofreader

LGTM

@NotAShelf NotAShelf merged commit a7d8a3f into nix-community:master Sep 10, 2025
3 checks passed
@orangci orangci deleted the patch-1 branch September 10, 2025 11:52
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.

2 participants