Basic configuration for spellcheck action

[jonasbn]

Basic configuration for checking spelling in Markdown and in English including an empty custom dictionary for words not covered by the dictionary

I have added a configuration file for the action to check the spelling the default is in the root of the repository, this can be moved, either request this or have a look at the documentation.

• https://github.com/rojopolis/spellcheck-github-actions?tab=readme-ov-file#how-to-declutter-your-root-directory-from-spellcheck-configuration-files

In addition an empty file: .wordlist.txt this file should be populated with all the words that are not covered by a the normal dictionary, like names and special technical terms etc.

Let me know if there are any questions or problems and I will see what I can do to accomodate.

How Has This Been Tested?

I have tested the configuration locally on my fork of the repository.

Checklist

• My code follows the style guidelines of this project
• I have performed a self-review of my code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules

Additional notes

This aims to address the issue raised in the repository: rojopolis/spellcheck-github-actions

[gemini-code-assist]

Summary of Changes

Hello, I'm Gemini Code Assist¹! 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 integrates a basic spell-checking mechanism into the repository, focusing on improving the quality and consistency of documentation written in Markdown. By introducing a dedicated configuration and a custom wordlist, it establishes a foundation for automated linguistic checks, aiming to reduce typos and grammatical errors in user-facing content without interfering with code segments.

Highlights

• Spellcheck Configuration Added: A new configuration file, .spellcheck.yml, has been introduced to enable automated spell checking within the repository's workflow. This configuration specifically targets Markdown files (**/*.md) and uses the English language.
• Custom Wordlist Included: An empty custom wordlist file, .wordlist.txt, has been added. This file is intended to be populated with project-specific terms, names, or technical jargon that should be ignored by the spell checker, preventing false positives.
• Markdown and HTML Filtering: The spellcheck configuration includes filters for Markdown and HTML, with specific instructions to ignore code blocks and preformatted text within HTML to avoid checking code syntax as natural language.

Changelog

• .spellcheck.yml
  • Added a new file to configure the spellcheck action.
  • Configured spell checking for Markdown files (**/*.md).
  • Set the spellcheck language to English (en).
  • Included .wordlist.txt as a custom dictionary.
  • Configured HTML filter to ignore code and pre tags.
• .wordlist.txt
  • Added an empty file to serve as a custom wordlist for the spell checker.

Activity

• The pull request author, jonasbn, created this PR to address an issue related to spell checking.
• The author has self-reviewed their code and tested the configuration locally on their fork.

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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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

1. 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. ↩

[gemini-code-assist]

Code Review

This pull request adds a basic configuration for a spellcheck GitHub Action, including a configuration file and an empty wordlist. The implementation is straightforward and correct. I have one suggestion to improve the clarity of the configuration file.

[gemini-code-assist]

For improved clarity and to prevent potential misinterpretation by readers or tools, it's better to explicitly define an empty mapping for a filter that uses default options. This makes the intention clear that no special configuration is needed for this filter.

  - pyspelling.filters.markdown: {}