Data Driven Forms is a monorepo that uses Lerna and yarn workspaces, so you can use all its commands as well.

Please follow following checklist if you are going to open a PR. It will help you make the PR finished.

  • Yarn build passes
  • Yarn lint passes
  • Yarn test passes
  • Test coverage for new code (if applicable)
  • Documentation update (if applicable)
  • Correct commit message
    • format fix|feat({scope}): {description}
    • i.e. 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
      • i.e. Fix button on documenation example page
yarn install
yarn build

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-mapper
yarn start

The documentation is a server-side rendered React application based on NextJS framework.

cd packages/react-renderer-demo
yarn dev
yarn lerna clean # will delete all node_modules

This command does not remove the root node_module folder.

To clean built files use:

yarn clean-build

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 test
yarn test --watchAll packages/pf4-component-mapper
# or
cd packages/pf4-component-mapper
yarn test

Data Driven Forms uses Semantic Release

Format:

[type]([package]): message
fix(pf4): title accepts node

Types:

  • feat: a new feature, will trigger new _.X._ release
  • fix: a fix, will trigger new _._.X release

Packages:

  • Please describe which package is being changed pf3, renderer, ...

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:

yarn generate-template

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.

  1. 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.
  2. Wrap the whole content into DocPage component:
import DocPage from '@docs/doc-page';
<DocPage>
  Your content
</DocPage>
  1. Add this information to the file:
    1. Description of the component
    2. A problem it may help to solve
    3. Example of the component implementation and usage in a form
  2. To create an example follow these steps:
    1. 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
    2. 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" />
  1. 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
    1. Title: text of the link
    2. Component: exact filename of the markdown file