This README is intended to further detail some of the steps mentioned in the PatternFly React Contributing Guide and help new contributors getting started with PatternFly React.
If you haven't already, we highly recommend taking a look at the React Documentation site. This contains up to date information on React from the project's core maintainers at Facebook.
We also have a few documents started on this subject with some helpful links and descriptions that might help you learn React. Feel free to add your own docs and helpful links here!
- Getting Started w/ React by Patrick Riley
See how to write documentation in the react-docs README
When writing examples:
- Keep them simple. It is much easier for a person to understand what is going on.
- Try not to add extra external dependencies. These will only be approved on a case by case basis.
PatternFly React currently uses Jest for running snapshot tests and Cypress for running integration tests.
Use Jest tests to capture how the DOM should look after rendering. Save Jest tests (*.test.tsx files) under a __tests__ folder. The most commonly used test is to expect a rendered component to match a snapshot. You can run these with yarn test.
Use Cypress tests to capture how the DOM should look after interactions. Save Cypress tests (*.spec.ts files) under packages/react-integration/cypress/integration. You can run these with yarn start:cypress.
PatternFly React has 3 linters you can run all at once using yarn lint:all. These are run in --fix mode in on your staged files each commit.
ESLint is run on .js, .jsx, .ts, and .tsx files. It uses the @typescript-eslint parser with custom config added over the years. We write some of our own ESLint rules in eslint-plugin-patternfly-react. You can run this linter with yarn lint:ts or on specific files with yarn lint <path>.
The @patternfly version linter is run on all package.json files to ensure that versions of all @patternfly/* packages match. This is done to prevent mismatching versions of essential PatternFly packages from accidentally being published. You can run this linter with yarn lint:versions.