Skip to content

fix: expand markdownlint ignore to unblock PRs#64

Open
brandon-fox wants to merge 3 commits intomainfrom
fix/markdownlint-ignore
Open

fix: expand markdownlint ignore to unblock PRs#64
brandon-fox wants to merge 3 commits intomainfrom
fix/markdownlint-ignore

Conversation

@brandon-fox
Copy link
Copy Markdown
Member

Expands .markdownlintignore to exclude checklists, .specify/memory, and scripts dirs — these contain generated/authored content with intentional formatting that shouldn't block CI.

These dirs contain generated/authored content with intentional formatting
that shouldn't block CI.
@gemini-code-assist
Copy link
Copy Markdown

Summary of Changes

Hello, 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 resolves an issue where markdownlint was causing CI failures by incorrectly flagging content in specific directories. By updating the .markdownlintignore file, the change ensures that generated or intentionally formatted content in checklists, .specify/memory, and scripts paths no longer blocks continuous integration, thus improving the efficiency of the development workflow.

Highlights

  • Markdownlint Configuration: Expanded the .markdownlintignore file to include checklists, .specify/memory, and scripts directories.
  • CI Unblocking: These exclusions prevent markdownlint from flagging generated or intentionally formatted content, thereby unblocking CI pipelines.
Changelog
  • .markdownlintignore
    • Added exclusions for **/checklists/**, .specify/memory/**, and scripts/** to prevent markdownlint from processing these directories.
Activity
  • No specific activity has been recorded for this pull request yet.
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.

Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

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

No issues found across 1 file

…stead

The hardcoded `globs` in the action config was overriding the
.markdownlintignore file, causing lint failures on excluded dirs.
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request expands the .markdownlintignore file to exclude more directories from markdown linting, with the goal of unblocking CI. The additions for checklists and .specify/memory seem reasonable given their likely content. However, the pattern for the scripts directory is very broad. I've suggested a more precise alternative that will still allow for linting of any markdown documentation within that directory, making the configuration more robust for the future.

Comment thread .markdownlintignore
**/repomix-*.md
**/checklists/**
.specify/memory/**
scripts/**
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The pattern scripts/** is quite broad. It will prevent any markdown files within the scripts directory (like a README.md) from being linted now or in the future. A more precise approach is to ignore the directory but re-include markdown files for linting. This ensures that documentation is still checked for quality, which can be important for script usage and maintenance.

scripts/
!scripts/**/*.md

Auto-generated file with intentional formatting.
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Mar 7, 2026

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.

1 participant