Skip to content

Latest commit

 

History

History
41 lines (33 loc) · 2.44 KB

CONTRIBUTING.md

File metadata and controls

41 lines (33 loc) · 2.44 KB
Raw

Contributing to UI-Schema

  1. Fork/Clone repository branch develop
  2. Install root dev-dependencies (like lerna, webpack): npm i
  3. Install & link the packages: npm run bootstrap && npm run link
  4. Start dev-server: npm start
    • (will clean-dist + start demo app)
  5. Open browser on localhost:4200 for demo
  6. Explore packages
  7. Code -> Commit -> Pull Request -> Being Awesome!

Changes from any package are reflected inside the demo package.

Commands:

  • Developing test driven: npm run tdd
    • needs manual bootstrapping and update handling
    • npm run tdd -- -u --testPathPattern=src/Validators
      • with -u|--update for snapshot update testing
      • with --testPathPattern to run all tests in a specific folder / path
      • npm run tdd -- --testPathPattern=PatternValidator -t patternValidator for only one test and often only one file
  • Testing: npm test
    • needs manual bootstrapping, linking and update handling
  • Build: npm run build
    • needs manual bootstrapping and update handling
  • Clean node_modules and build dirs: npm run clean
  • Clean build dirs: npm run clean-dist
  • Add new node_module to one package: lerna add <npm-package-name> --scope=@ui-schema/demo [--dev] [--peer], without --scope in all packages
  • Do not change package.json of packages manually, and if Bootstrap lerna: npm run bootstrap (maybe delete package-lock.json), or simply open an issue
  • Add new package lerna create <name> and follow on screen, e.g.: lerna create material-pickers add package name @ui-schema/material-pickerss, creates folder ./packages/material-pickers

All-in-one clean & reinstall command - skip the first one if not installed completely: npm run clean && rm -rf node_modules && rm -f package-lock.json && npm i && npm run bootstrap && npm run bootstrap && npm run link

The two-times bootstrap fixes sometimes stale packages dependencies/lock-files, but sometimes a manual deletion of those also helps with node_modules resolving issues.

Contributors

By committing your code/creating a pull request to this repository you agree to release the code under the MIT License attached to the repository and to adhere to the CODE_OF_CONDUCT.

Questions? Feel free to open discussions or join the slack channel!