DevOps & Tooling · ChatGPT and the OpenAI API
Playwright End-to-End Testing OpenAI Custom Instructions
Custom instructions for ChatGPT and the OpenAI API, for Playwright End-to-End Testing work.
- Path
- prompts/openai-custom-instructions.md
- Loads
- Pasted or sent per request
- Format
- Markdown (.md)
- Used by
- ChatGPT and the OpenAI API
What this file tells the agent
Custom instructions in ChatGPT, a Project or the API tell the model your Playwright End-to-End Testing conventions up front: concise diffs, validation at the boundaries and explicit error handling.
- Strictly ban hardcoded delays (page.waitForTimeout()); rely exclusively on Playwright web-first auto-waiting assertions (expect(locator).toBeVisible()).
- Prioritize user-facing accessible locators: page.getByRole(), page.getByLabel(), and page.getByTestId(); never write fragile CSS selectors or brittle XPaths.
- Encapsulate multi-step interactions inside modular Page Object Models (POM) with typed parameters.
- Ensure total test isolation: authenticate via storage state (storageState) instead of repeating manual UI logins in every test.
- Configure trace viewer and video capture on first retry (trace: 'on-first-retry') for painless CI debugging.
Code to avoid, and what to write instead
The rule steers the agent away from the left and toward the right.
// Flaky: Brittle selectors, arbitrary sleep timeouts, and no auto-waiting
test("bad test", async ({ page }) => {
await page.goto("/catalog");
await page.click("div.col-md-4 > button:nth-child(2)"); // Breaks on minor CSS tweak!
await page.waitForTimeout(5000); // Flaky anti-pattern!
const text = await page.innerText("#cart-total");
expect(text).toBe("1");
});import { test, expect } from "@playwright/test";
test.describe("Checkout Flow", () => {
test("allows user to complete cart purchase", async ({ page }) => {
await page.goto("/catalog");
// Accessible, user-facing locators
await page.getByRole("button", { name: "Add to Cart" }).first().click();
await page.getByRole("link", { name: "Cart (1)" }).click();
// Auto-waiting assertions
await expect(page.getByRole("heading", { name: "Your Shopping Cart" })).toBeVisible();
await page.getByRole("button", { name: "Proceed to Checkout" }).click();
await expect(page).toHaveURL(/.*checkout/);
});
});Install it in one command
- 01
Go to your project root
The file goes at prompts/openai-custom-instructions.md, relative to the root.
- 02
Download the file
Run the command on the right. It downloads this preset and writes the file.
- 03
Make sure it gets used
Nothing loads this file automatically. Paste it into ChatGPT custom instructions, a Project or a custom GPT, or send it as instructions in the API.
$ mkdir -p "prompts" && curl -fsSL "https://www.devscratchpad.tech/api/raw/openai-instructions/playwright-e2e" -o "prompts/openai-custom-instructions.md"
writes prompts/openai-custom-instructions.md
prompts/openai-custom-instructions.md
To write the file from your own code instead, use Read your code or Convert Legacy Rules in the editor above.
More for Playwright End-to-End Testing
Questions
- Where do I apply these OpenAI instructions?
- Paste it into ChatGPT custom instructions (Settings > Personalization), a Project's instructions or a custom GPT, or send it as instructions in the OpenAI API.
- Which OpenAI models can use these instructions?
- Any current model in ChatGPT or the API. The instructions are plain text, so they work the same way whichever model you pick.