Skip to content

docs: Add setup:e2e script for installing playwright chromium and upd…#33

Open
bholly24 wants to merge 1 commit intomrjasonroy:mainfrom
bholly24:docs/setup-e2e-script
Open

docs: Add setup:e2e script for installing playwright chromium and upd…#33
bholly24 wants to merge 1 commit intomrjasonroy:mainfrom
bholly24:docs/setup-e2e-script

Conversation

@bholly24
Copy link

Description

Add a script for installing chromium for e2e tests and update setup documentation for clarity.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Chore (dependencies, CI, etc.)

Testing

  • All existing tests pass (pnpm test)
  • Added new tests for new functionality
  • Tested with memory cache handler
  • Tested with Redis cache handler (if applicable)
  • [X ] E2E tests pass (pnpm test:e2e)

Checklist

  • My code follows the project's code style (pnpm lint passes)
  • I have run pnpm format to format my code
  • [X ] Type checking passes (pnpm typecheck)
  • [X ] I have updated the documentation accordingly
  • [X ] My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • [X ] New and existing unit tests pass locally with my changes

Related Issues

Additional Context

@bholly24 bholly24 requested a review from mrjasonroy as a code owner March 10, 2026 13:26
@gemini-code-assist
Copy link

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 enhances the developer experience by streamlining the setup process for end-to-end testing. It introduces a dedicated script to install Playwright Chromium and updates the contribution documentation to guide developers through the new, more efficient setup. This change aims to make it easier for contributors to get their development environment ready for e2e testing and to ensure comprehensive test coverage.

Highlights

  • New E2E Setup Script: A new setup:e2e script was added to package.json to simplify the installation of Playwright Chromium, which is essential for running end-to-end tests.
  • Updated Contribution Guidelines: The CONTRIBUTING.md file was updated to include a new step for setting up e2e testing using the pnpm setup:e2e command, improving clarity for new contributors.
  • Comprehensive Test Command: The combined test command in CONTRIBUTING.md was updated to include pnpm test:e2e, ensuring that all tests, including end-to-end tests, are run with a single command.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • CONTRIBUTING.md
    • Added a new step for setting up e2e testing using pnpm setup:e2e.
    • Modified the combined test command to include pnpm test:e2e.
  • package.json
    • Added a new setup:e2e script to install Playwright Chromium with dependencies.
Ignored Files
  • Ignored by pattern: .github/workflows/** (2)
    • .github/workflows/ci.yml
    • .github/workflows/nextjs-canary-test.yml
Activity
  • No human activity has been recorded on 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

@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 introduces end-to-end (e2e) testing setup by adding a setup:e2e script to package.json for installing Playwright dependencies. The CONTRIBUTING.md file is updated to include instructions for setting up e2e testing and to incorporate pnpm test:e2e into the comprehensive testing command.

Note: Security Review has been skipped due to the limited scope of the PR.

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