This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file helps humans and coding agents work safely in this repository. It summarizes how the app is built, how to validate changes, and where code lives.
## What this project is
Official [PatternFly React seed](https://github.com/patternfly/patternfly-react-seed): a small React + TypeScript app with PatternFly layout, React Router, Webpack, and Vitest. It is a reference for wiring PatternFly into a real app, not a component library.
- `vitest.config.ts` — Test runner and `@app` alias for tests
## Path aliases
- `@app/*` → `src/app/*` (Webpack and Vitest)
- `@assets/*` → PatternFly packaged assets under `node_modules/@patternfly/react-core/dist/styles/assets/*`
Use these for imports instead of long relative paths where the codebase already does.
## PatternFly and UI conventions
- Global styles: import `@patternfly/react-core/dist/styles/base.css` from the app root (see `src/app/index.tsx`).
- Prefer PatternFly React components for structure and layout (`Page`, `PageSection`, navigation patterns) before ad hoc markup or utility-only layouts.
- Match existing file style: quote style, import order (ESLint `sort-imports` is enabled with `ignoreDeclarationSort`).
## Testing
- Tests live next to features (e.g. `src/app/app.test.tsx`).
- Vitest uses `jsdom` and `./src/test/setup.ts` for globals/setup.
## Things that commonly break CI
- **Unused imports or variables** in `src/` — fix or remove them; ESLint treats them as errors.
- **Omitting `npm run lint` or `npm run type-check`** after edits — run at least those before opening a PR.
- **`npm run ci-checks` fails on coverage** — ensure `@vitest/coverage-v8` is installed (`npm install`) and matches the major Vitest version in `package.json`.
## Optional: PatternFly MCP
For up-to-date PatternFly component APIs and docs, agents can use the [PatternFly MCP server](https://www.npmjs.com/package/@patternfly/patternfly-mcp) if the user’s environment has it configured.
## When unsure
- Prefer patterns already used under `src/app/`.
- Read `README.md` for asset loading (`@app`, `@assets`, SVG/bgimages) and script reference.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Start the express server (run a production build first)
# Serve the production build with sirv (run npm run build first)
npm run start
```
## Configurations
* [TypeScript Config](./tsconfig.json)
* [Webpack Config](./webpack.common.js)
* [Jest Config](./jest.config.js)
* [Vitest Config](./vitest.config.ts)
* [Editor Config](./.editorconfig)
For coding agents and automation, see [AGENTS.md](./AGENTS.md) (validation commands, layout, and conventions).
## Raster image support
To use an image asset that's shipped with PatternFly core, you'll prefix the paths with "@assets". `@assets` is an alias for the PatternFly assets directory in node_modules.
Expand Down
Expand Up
@@ -88,7 +90,7 @@ When importing CSS from a third-party package for the first time, you may encoun
* For accessibility compliance, we use [react-axe](https://github.com/dequelabs/react-axe)
* To keep our bundle size in check, we use [webpack-bundle-analyzer](https://github.com/webpack-contrib/webpack-bundle-analyzer)
* To keep our code formatting in check, we use [prettier](https://github.com/prettier/prettier)
* To keep our code logic and test coverage in check, we use [jest](https://github.com/facebook/jest)
* To keep our code logic and test coverage in check, we use [Vitest](https://vitest.dev/)
* To ensure code styles remain consistent, we use [eslint](https://eslint.org/)
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
fix: Added updates for agent ready. #273
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
Uh oh!
There was an error while loading. Please reload this page.
fix: Added updates for agent ready. #273
Filter by extension
Only manifest files
Viewed files
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
There are no files selected for viewing
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.