Repository navigation
Chore/add codespell ignore words - #212
Conversation
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. Caution Review failedThe pull request is closed. 📝 WalkthroughSummary by CodeRabbit
WalkthroughAdds a codespell ignore file with 16 terms and updates the GitHub Actions spell-check workflow to pass that file to codespell via Changes
Sequence Diagram(s)sequenceDiagram
participant Dev as Developer
participant GH as GitHub Actions
participant Codespell as codespell
participant Ignore as .github/.codespellignorewords
Dev->>GH: Push/PR triggers spell-check workflow
GH->>Codespell: Run codespell with --skip list and -I Ignore
Codespell->>Ignore: Load ignore terms
Codespell->>GH: Report findings excluding ignored terms
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 💡 Knowledge Base configuration:
You can enable these sources in your CodeRabbit configuration. 📒 Files selected for processing (1)
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @NiveditJain, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request introduces a new configuration file for codespell to ignore a predefined list of words. This change aims to reduce false positives during spelling checks by preventing codespell from flagging specific proper nouns, acronyms, and domain-specific terms as errors, thereby improving the accuracy of the spell-checking process.
Highlights
- codespell configuration: A new file, .github/.codespellignorewords, has been added to the repository.
- Ignored words: This file contains a list of words, including proper nouns, acronyms, and project-specific terms, that codespell should now ignore during its checks.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request introduces a .codespellignorewords file to manage exceptions for the codespell linter. The added words are mostly project-specific terms and common acronyms. My review focuses on improving the maintainability of this new file by suggesting to sort the entries and to address a potential typo (expsphere) which might be better fixed in the source code.
| SDK | ||
| S3 | ||
| Kusto | ||
| expsphere No newline at end of file |
There was a problem hiding this comment.
The word expsphere appears to be a typo of exosphere. It's recommended to fix typos in the codebase directly instead of adding them to an ignore list. This improves overall code quality and prevents confusion. Please consider removing expsphere from this list and correcting the typo in the source code where it occurs.
|
@cursoragent remove expsphere from list of Ingored spellings |
|
I updated the
Learn more about Cursor Agents |
Co-authored-by: nivedit <nivedit@aikin.club>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🔭 Outside diff range comments (1)
.github/workflows/spell-check.yml (1)
17-18: Pin codespell to a known-good version in CITo avoid flaky builds when codespell’s dictionaries or behavior change, update
.github/workflows/spell-check.yml:
- File:
.github/workflows/spell-check.yml, lines 17–18- name: Install codespellrun: pip install codespell
run: pip install codespell==2.4.1
- If you’d like non-breaking bugfixes within the 2.4 series, use the compatible operator instead:
run: pip install "codespell~=2.4.1"- Add a scheduled Dependabot/Renovate or GitHub Actions job to bump the exact version regularly (e.g. 2.4.1 → 2.4.2), run tests, and then update the pin once verified.
Latest stable release: 2.4.1 (Jan 28, 2025) [1][2]
Citations:
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
.github/.codespellignorewords(1 hunks).github/workflows/spell-check.yml(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-08-03T04:26:00.148Z
Learnt from: NiveditJain
PR: exospherehost/exospherehost#131
File: state-manager/app/models/executed_models.py:0-0
Timestamp: 2025-08-03T04:26:00.148Z
Learning: The exospherehost project is currently in beta phase, so breaking changes in APIs are acceptable and don't require versioning or migration strategies.
Applied to files:
.github/.codespellignorewords
🔇 Additional comments (2)
.github/.codespellignorewords (1)
1-17: Ignore list is case-sensitive; retain both lowercase and CamelCase entriesCodespell’s
-Iignore file matches entries case-sensitively. A lowercase word will not suppress its capitalized form, so you do need to keep both variants (e.g.exosphereandExosphere). No deduplication here—each casing you want to ignore must be listed explicitly.References:
- “words you put in ‑I must match the case you want ignored” (codespell README)
.github/workflows/spell-check.yml (1)
21-21: Good addition: using an ignore words file with codespell.Adding “-I .github/.codespellignorewords” is the right move for maintainability.
Co-authored-by: nivedit <nivedit@aikin.club>
2 participants
No description provided.