Please follow following checklist if you are going to open a PR. It will help you make the PR finished.
- Test coverage for new code (if applicable)
- Documentation update (if applicable)
- Correct commit message
fix(pf3): wizard correctly handles next button
- fix will release a new _._.X version
- feat will release a new _.X._ version (use when you introduce new features)
- we want to avoid any breaking changes, please contact us, if there is no way how to avoid them
- scope: package
- if you update the documentation or tests, do not use this format
Fix button on documenation example page
All packages are linked together by default, so if you run a
yarn build in a package, all other packages are updated to the latest version of that package.
Don't forget to build all packages, which are linked together!
Each package has a small playground
package/demo, where you can test your changes.
cd packages/pf3-component-mapperyarn start
The documentation is a server-side rendered React application based on NextJS framework.
cd packages/react-renderer-demoyarn dev
yarn lerna clean # will delete all node_modules
This command does not remove the root
To clean built files use:
This script is also ran automatically before each build.
You can test parsers using tests. Tests can be ran from core folder or from specific package.
yarn testyarn test --watchAll packages/pf4-component-mapper# orcd packages/pf4-component-mapperyarn test
Data Driven Forms uses Semantic Release
[type]([package]): messagefix(pf4): title accepts node
feat: a new feature, will trigger new
fix: a fix, will trigger new
- Please describe which package is being changed
Please, do not use Semantic Release, if you update only the demo.
All packages are releasing together and they share the version number.
If your changes influence API or add new features, you should describe these new options in the
react-renderer-demo repository. Thanks!
To generate a mapper template, run:
This command starts a CLI, that provides an interface for generating mappers. A mapper folder will be created and it will be populated with all neccesary files.
To add additional examples of custom form components, please follow these steps.
- Create a new markdown file in this directory: https://github.com/data-driven-forms/react-forms/tree/master/packages/react-renderer-demo/src/pages/examples.
- Wrap the whole content into
import DocPage from '@docs/doc-page';<DocPage>Your content</DocPage>
- Add this information to the file:
- Description of the component
- A problem it may help to solve
- Example of the component implementation and usage in a form
- To create an example follow these steps:
- Create a new JS file in this directory: https://github.com/data-driven-forms/react-forms/tree/master/packages/react-renderer-demo/src/examples/components/examples
- Import the code example using this path
components/examples/<file name without extenstion>
import CodeExample from '@docs/code-example';<CodeExample source="components/examples/sample-example" mode="preview" />
- Add the component to the navigation. Add a new object to this file: https://github.com/data-driven-forms/react-forms/blob/master/packages/react-renderer-demo/src/components/navigation/schemas/custom-examples.schema.js
- Title: text of the link
- Component: exact filename of the markdown file