Skip to content

test: add readmeGenerator accessibility coverage#4981

Open
mayank200529 wants to merge 3 commits into
JhaSourav07:mainfrom
mayank200529:test-readme-generator-accessibility
Open

test: add readmeGenerator accessibility coverage#4981
mayank200529 wants to merge 3 commits into
JhaSourav07:mainfrom
mayank200529:test-readme-generator-accessibility

Conversation

@mayank200529

Copy link
Copy Markdown
Contributor

Description

Fixes #4590

Added accessibility-focused test coverage for readmeGenerator.

Coverage

  • Verifies generated README headings follow a logical hierarchy.
  • Ensures technology icons include accessible alt and title attributes.
  • Validates social icons expose accessible labels for assistive technologies.
  • Confirms generated social links remain keyboard accessible through standard anchor markup.
  • Checks CommitPulse badge uses descriptive alt text for screen readers.

Pillar

  • 🎨 Pillar 1 — New Theme Design
  • 📐 Pillar 2 — Geometric SVG Improvement
  • 🕐 Pillar 3 — Timezone Logic Optimization
  • 🛠️ Other (Bug fix, refactoring, docs)

Visual Preview

N/A (test-only change)

Checklist before requesting a review:

  • I have read the CONTRIBUTING.md file.
  • I have tested these changes locally (localhost:3000/api/streak?user=YOUR_USERNAME).
  • I have run the relevant tests locally.
  • My commits follow the Conventional Commits format (e.g., feat(themes): ..., fix(calculate): ...).
  • I have updated README.md if I added a new theme or URL parameter.
  • I have started the repo.
  • I have made sure that I have only one commit to merge in this PR.
  • The SVG output matches the CommitPulse quality standards (no production SVG changes made).
  • (Recommended) I joined the CommitPulse Discord community for contributor discussions, mentorship, and faster PR support.

@vercel

vercel Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

@mayank200529 is attempting to deploy a commit to the jhasourav07's projects Team on Vercel.

A member of the Team first needs to authorize it.

@github-actions github-actions Bot added the type:testing Adding, updating, or fixing tests label Jun 9, 2026
@mayank200529

Copy link
Copy Markdown
Contributor Author

@JhaSourav07

@Aamod-Dev Aamod-Dev added level:beginner Small changes Usually isolated fixes or simple UI/text updates. GSSoC 2026 mentor:Aamod007 labels Jun 11, 2026

@Aamod-Dev Aamod-Dev left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks for the PR. I am requesting changes because this adds an 'accessibility' test suite to the 'readmeGenerator' utility. The readme generator creates markdown strings on the server and does not render HTML DOM elements with ARIA roles or focus states. Testing it for accessibility is invalid. Please remove this test or target an interactive UI component.

@Aamod-Dev Aamod-Dev added level:intermediate Moderate complexity tasks quality:clean PR follows clean coding practices, proper formatting, documentation, and maintainability standards. labels Jun 11, 2026

@Aamod-Dev Aamod-Dev left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks for the contribution. I went through the changes and the overall approach looks good. The accessibility improvements and ARIA attribute coverage look great and will really help screen reader users. Happy to approve this.

@mayank200529

Copy link
Copy Markdown
Contributor Author

who will merge this pr??

@mayank200529 mayank200529 force-pushed the test-readme-generator-accessibility branch from b4aec40 to 527b2b1 Compare June 11, 2026 18:46
@mayank200529

Copy link
Copy Markdown
Contributor Author

issue solved merge pr

@github-actions github-actions Bot added the status:blocked This PR is blocked due to a failing CI check. label Jun 11, 2026
@github-actions

Copy link
Copy Markdown
Contributor

🚨 Hey @mayank200529, the CI Pipeline is failing on this PR and it has been marked as status:blocked.

Please fix the issues before this can be reviewed. Here's how:

1. Run checks locally before pushing:

npm run format:check   # Check Prettier formatting
npm run lint           # Run ESLint
npm run typecheck      # TypeScript type check
npm run test           # Run unit tests (Vitest)
npm run build          # Verify production build passes

2. Auto-fix common issues:

npm run format         # Auto-fix formatting with Prettier
npm run lint -- --fix  # Auto-fix lint errors where possible

3. Check the full failure log here:
👉 View CI Run

Once you push a fix and the CI passes, the status:blocked label will be removed automatically. 💪

@Aamod-Dev Aamod-Dev left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Good work on this one. I reviewed the diff and it looks ready to go from my side.

No concerns from my end. Approved.

@Aamod-Dev Aamod-Dev removed the level:beginner Small changes Usually isolated fixes or simple UI/text updates. label Jun 12, 2026

@Aamod-Dev Aamod-Dev left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This PR is currently marked with the \status:blocked\ label. Please resolve the blockers so we can proceed with a full review and approval.

@Aamod-Dev Aamod-Dev added level:advanced Complex contributions involving architecture, optimization, or significant feature work quality:clean PR follows clean coding practices, proper formatting, documentation, and maintainability standards. type:feature New features, additions, or enhancements type:docs Documentation changes, wikis, or README updates type:accessibility Accessibility (a11y) improvements and screen reader fixes and removed level:intermediate Moderate complexity tasks quality:clean PR follows clean coding practices, proper formatting, documentation, and maintainability standards. labels Jun 13, 2026

@Aamod-Dev Aamod-Dev left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks for the contribution! I went through the changes and have evaluated them according to the rubric.

@Aamod-Dev Aamod-Dev left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Please fix the issues that caused the blocked label before this can be approved.

@github-actions

Copy link
Copy Markdown
Contributor

⚠️ Hey @mayank200529, this pull request has been inactive for 3 days. It will be automatically closed in 2 days if no further activity occurs.

If you are still working on this, please push your latest changes or leave a comment to keep it active.

@Aamod-Dev Aamod-Dev added the level:intermediate Moderate complexity tasks label Jun 18, 2026

@Aamod-Dev Aamod-Dev left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Difficulty: intermediate – Accessibility tests for screen reader aria compliance.

Quality: clean – A11y coverage.

Type: testing + accessibility – Important a11y work.

Great tests!

@Aamod-Dev Aamod-Dev left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Review

This PR cannot be approved in its current state due to blocking issues (status:blocked label, merge conflicts, needs-rebase label, and/or failing CI checks). Please resolve the blocking issues and re-request review.

Once unblocked, I'm happy to re-review! 💚

@Aamod-Dev Aamod-Dev left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Adding accessibility tests for readmeGenerator is fantastic. Ensuring that headings, alt text, and social icons generated in READMEs comply with accessibility standards is a great win. However, this PR is currently marked as blocked. Please resolve the blocking issues so we can merge this in.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

accessibility GSSoC 2026 level:advanced Complex contributions involving architecture, optimization, or significant feature work level:intermediate Moderate complexity tasks mentor:Aamod007 quality:clean PR follows clean coding practices, proper formatting, documentation, and maintainability standards. status:blocked This PR is blocked due to a failing CI check. testing type:accessibility Accessibility (a11y) improvements and screen reader fixes type:docs Documentation changes, wikis, or README updates type:feature New features, additions, or enhancements type:testing Adding, updating, or fixing tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

test(readmeGenerator-accessibility): verify Accessibility Standards & Screen Reader Aria Compliance (Variation 4)

3 participants