chore: add spellchecker and run

[Vritra4]

similar one with initia`s

Summary by CodeRabbit

• New Features

  • Introduced a new .codespellignore file to enhance spell checking by excluding project-specific terms.
  • Added an automated GitHub Actions workflow for spell checking in pull requests, improving code quality through consistent typo detection.

• Bug Fixes

  • Corrected the spelling of "Usage" in the Dockerfile comments for clarity.

• Documentation

  • Updated comments in the Broadcaster methods for grammatical consistency.

[coderabbitai]

Walkthrough

This pull request introduces a new .codespellignore file to specify terms that the codespell tool should ignore during spell checks, enhancing the efficiency of the spell-checking process. Additionally, a new GitHub Actions workflow named spellcheck.yml is created to automate spell checking on pull request events. Minor corrections are made to comments in the Dockerfile and node/broadcaster/process.go, improving grammatical accuracy without altering functionality.

Changes

File	Change Summary
.github/config/.codespellignore	New file created with terms to be ignored by codespell: cips, pullrequest, keypair, etc.
.github/workflows/spellcheck.yml	New GitHub Actions workflow for automated spell checking on pull requests.
Dockerfile	Corrected comment from "Useage" to "Usage"; no functional changes.
node/broadcaster/process.go	Minor comment updates for grammatical consistency in HandleNewBlock and CheckPendingTx methods; no functional changes.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GitHub
    participant Codespell
    participant PR_Creator

    User->>GitHub: Create Pull Request
    GitHub->>Codespell: Trigger Spell Check
    Codespell->>Codespell: Run checks, ignore specified terms
    Codespell-->>GitHub: Return results
    GitHub->>PR_Creator: Create Pull Request with results

Loading

🐰 "In the code, where words may stray,
A spellcheck now keeps errors at bay.
With a list of terms, we proudly declare,
Our project’s language is handled with care.
Hopping through code, with joy we sing,
For every typo, a fix we bring!" 🐇✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 golangci-lint

level=warning msg="The linter 'exportloopref' is deprecated (since v1.60.2) due to: Since Go1.22 (loopvar) this linter is no longer relevant. Replaced by copyloopvar."

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

[beer-1]

LGTM

[coderabbitai]

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (2)

.github/workflows/spellcheck.yml (2)

3-4: Consider adding more trigger events

The workflow currently only runs on pull requests. Consider adding triggers for direct pushes to main branches to ensure spell checking coverage for all code changes.

 on:
   pull_request:
+  push:
+    branches: [ main, master ]

---

17-28: Enhance PR creation configuration

Consider these improvements for better PR management:

1. Use a dynamic branch name to avoid conflicts
2. Add more context to PR description
3. Set assignees and reviewers

       - uses: peter-evans/[email protected]
         if: github.event_name != 'pull_request'
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           commit-message: "chore: fix typos"
           title: "chore: fix typos"
-          branch: "chore/fix-typos"
+          branch: "chore/fix-typos-${{ github.sha }}"
           delete-branch: true
+          assignees: ${{ github.actor }}
+          reviewers: ${{ github.repository_owner }}
           body: |
             This PR fixes typos in the codebase.
+            
+            ## Changes
+            - Automated typo fixes using codespell
+            - Generated from commit: ${{ github.sha }}
+            
             Please review it, and merge if everything is fine.
             If there are proto changes, run `make proto-gen` and commit the changes.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 13e1849 and c539fff.

📒 Files selected for processing (4)

• .github/config/.codespellignore (1 hunks)
• .github/workflows/spellcheck.yml (1 hunks)
• Dockerfile (1 hunks)
• node/broadcaster/process.go (2 hunks)

✅ Files skipped from review due to trivial changes (3)

• .github/config/.codespellignore
• Dockerfile
• node/broadcaster/process.go

🔇 Additional comments (2)

.github/workflows/spellcheck.yml (2)

6-9: LGTM!

The job configuration is clean and appropriate for the task.

---

10-11: LGTM!

Using the latest version of checkout action is good practice.