Skip to content

ci: fix markdown formatting for contributing.md to pass markdownlint#195

Closed
richm wants to merge 1 commit into
mainfrom
fix-markdown-formatting-for-contributing
Closed

ci: fix markdown formatting for contributing.md to pass markdownlint#195
richm wants to merge 1 commit into
mainfrom
fix-markdown-formatting-for-contributing

Conversation

@richm

@richm richm commented Sep 9, 2025

Copy link
Copy Markdown
Contributor

fix markdown formatting for contributing.md to pass markdownlint

Signed-off-by: Rich Megginson rmeggins@redhat.com

Summary by Sourcery

Documentation:

  • Update CONTRIBUTING.md to adhere to markdownlint formatting rules

fix markdown formatting for contributing.md to pass markdownlint

Signed-off-by: Rich Megginson <rmeggins@redhat.com>
@richm richm self-assigned this Sep 9, 2025
@sourcery-ai

sourcery-ai Bot commented Sep 9, 2025

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Update contributing.md to align with markdownlint rules by refining headings, list structures, code fences, and whitespace/line breaks.

File-Level Changes

Change Details Files
Standardize heading formatting
  • Normalize heading levels
  • Insert required blank lines before and after headings
contributing.md
Normalize list structures
  • Ensure a single space after list markers
  • Apply consistent indentation for nested lists
contributing.md
Convert code snippets to fenced blocks
  • Switch inline code blocks to ``` fences with language tags
  • Add blank lines surrounding each code block
contributing.md
Clean up whitespace and line breaks
  • Remove trailing spaces
  • Wrap or break overly long lines to satisfy line-length lint rule
contributing.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hey there - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@richm richm closed this Sep 9, 2025
@richm richm deleted the fix-markdown-formatting-for-contributing branch September 9, 2025 14:33
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