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

Hotfix - Documentation and Build Process fix #23

Merged
merged 9 commits into from
Jun 14, 2024

Conversation

khleomix
Copy link
Contributor

@khleomix khleomix commented Jun 10, 2024

Closes

WDSBT-22

Link to test

  • Test locally for now.

Description

  • Update README.
  • Fix build process
  • Fix a11y test script
  • Fix preinstall script to be compatible across platforms

Related Tickets & Documents

Mobile & Desktop Screenshots/Recordings

N/A

Added to documentation?

  • 📜 README.md
  • 📓 Confluence
  • 🙅 No documentation needed

Added tests?

  • 👍 Yes
  • 🙅 No, because they aren't needed
  • 🙋 No, because I need help

Testing Instructions


Reviewer's Testing Checklist

As a reviewer, please verify that the relevant testing criteria are fulfilled and confirmed before approving this Pull Request.

  • Visual Regression Testing: Ensure that existing functionality is not negatively impacted by the changes.
  • Cross-Browser Compatibility: Test on major browsers (Chrome, Firefox, Safari) to ensure compatibility.
  • Mobile Responsiveness: Confirm that the changes are responsive and functional on various mobile devices.
  • Theme Compatibility: Ensure that the changes do not adversely affect the site's theme and styling.
  • Linting: Check that the code passes all linting checks (PHPCS, ESLint, SassLint). Check if PR passes code quality check.
  • Accessibility Testing: Validate that the changes comply with accessibility standards. Run npm run a11y.
  • Security Best Practices: Ensure that the code follows WordPress security best practices. Check if PR passes security check.
  • Documentation: Ensure that any new features or changes are appropriately documented in the README.md or Confluence.
  • Post-Deployment Tasks: Check if there are any tasks that need to be performed after deployment.

[optional] Additional Reviewer Notes or Considerations?

@khleomix khleomix self-assigned this Jun 10, 2024
@khleomix khleomix added documentation Improvements or additions to documentation hotfix Urgent patches for critical issues. labels Jun 10, 2024
a11y.cjs Dismissed Show dismissed Hide dismissed
@khleomix khleomix marked this pull request as ready for review June 14, 2024 15:15
@khleomix khleomix requested a review from lswilson June 14, 2024 15:16
Copy link
Contributor

@thatmitchcanter thatmitchcanter left a comment

Choose a reason for hiding this comment

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

Looks good - approved!

Copy link
Member

@lswilson lswilson left a comment

Choose a reason for hiding this comment

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

Looks good JC - thank you. Approved!

@khleomix khleomix merged commit 5d5826e into main Jun 14, 2024
7 checks passed
@khleomix khleomix deleted the hotfix/license-readmetxt branch June 14, 2024 15:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation hotfix Urgent patches for critical issues.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants