Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix lint issues #69

Closed
wants to merge 2 commits into from
Closed

Fix lint issues #69

wants to merge 2 commits into from

Conversation

Nidhi091999
Copy link
Contributor

@Nidhi091999 Nidhi091999 commented Jan 23, 2025

Summary by Sourcery

Chores:

  • Standardize comments and line breaks in GitHub Actions workflows.

Copy link

sourcery-ai bot commented Jan 23, 2025

Reviewer's Guide by Sourcery

This pull request addresses linting issues in the project. It modifies the markdownlint configuration file to enforce stricter rules and updates the GitHub workflow files to improve readability.

State diagram for Markdown linting rules

stateDiagram-v2
    [*] --> Headings
    Headings --> Lists
    Lists --> LineLength
    LineLength --> Formatting
    Formatting --> Links
    Links --> [*]

    state Headings {
        [*] --> IncrementByOne
        IncrementByOne --> ATXStyle
        ATXStyle --> [*]
    }

    state Lists {
        [*] --> DashStyle
        DashStyle --> ConsistentIndent
        ConsistentIndent --> [*]
    }

    state Formatting {
        [*] --> NoHardTabs
        NoHardTabs --> ProperSpacing
        ProperSpacing --> BlankLines
        BlankLines --> [*]
    }

    note right of Headings: ATX style enforced
    note right of Lists: Dash (-) for markers
    note right of LineLength: 80 chars, excluding code & tables
    note right of Links: Required alt text & proper URLs
Loading

Flow diagram of the updated PR validation workflow

graph TD
    A[PR Event] --> B{Check Event Type}
    B -->|opened/reopened/ready_for_review| C[Semantic Title Check]
    B -->|edited| D{Title Changed?}
    D -->|Yes| C
    D -->|No| E[Skip Check]
    C --> F[Use semantic-pull-request Action]
    style C fill:#f9f,stroke:#333,stroke-width:2px
Loading

File-Level Changes

Change Details Files
Modified markdownlint configuration to enforce stricter linting rules.
  • Updated heading rules to enforce a consistent style.
  • Updated unordered list rules to enforce consistent marker style and indentation.
  • Updated line length rules to limit line length to 80 characters.
  • Updated trailing spaces rules to ensure no trailing spaces at the end of lines.
  • Updated punctuation rules to ensure proper punctuation in headings.
  • Updated horizontal rules to enforce a consistent style.
  • Updated links and images rules to require proper use of URLs in links and alt text for images.
  • Updated general formatting rules to enforce no hard tabs, no multiple consecutive blank lines, and other formatting rules.
{{ cookiecutter.project_name_dashed }}/.markdownlint.yaml
Updated GitHub workflow files for improved readability.
  • Added newlines to improve readability of the conditional statement in the 'Semantic PR title' job in 'pr_validation.yaml'.
  • Updated comments in 'code_test.yaml' and 'vulnerability.yaml' to use a consistent style.
{{ cookiecutter.project_name_dashed }}/.github/workflows/pr_validation.yaml
{{ cookiecutter.project_name_dashed }}/.github/workflows/code_test.yaml
{{ cookiecutter.project_name_dashed }}/.github/workflows/vulnerability.yaml

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!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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

Copy link

@sourcery-ai sourcery-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.

Hey @Nidhi091999 - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider keeping a space after comment hashes (# ) throughout the configuration files - this is a common convention that improves readability
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

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.

@JaeAeich
Copy link
Collaborator

JaeAeich commented Feb 7, 2025

we dont have rules like this, I think this is your own formatter;s config, either way closing the PR due to unverfired commits, please make the formatting conform only to the rules defined in the PR.

@JaeAeich JaeAeich closed this Feb 7, 2025
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.

2 participants