Skip to content
New issue

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

docs: improve form validation examples (closes #4550) #4584

Merged
merged 1 commit into from Jan 9, 2020

Conversation

@jackmu95
Copy link
Member

jackmu95 commented Jan 9, 2020

Describe the PR

This PR improves the form validation examples in the docs reference section by adding live examples.
It also includes a new example form VeeValidate v3.

Closes #4550.

PR checklist

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Enhancement
  • ARIA accessibility
  • Documentation update
  • Other (please describe)

Does this PR introduce a breaking change? (check one)

  • No
  • Yes (please describe)

The PR fulfills these requirements:

  • It's submitted to the dev branch, not the master branch
  • When resolving a specific issue, it's referenced in the PR's title (i.e. [...] (fixes #xxx[,#xxx]), where "xxx" is the issue number)
  • It should address only one issue or feature. If adding multiple features or fixing a bug and adding a new feature, break them into separate PRs if at all possible.
  • The title should follow the Conventional Commits naming convention (i.e. fix(alert): not alerting during SSR render, docs(badge): update pill examples, chore(docs): fix typo in README, etc). This is very important, as the CHANGELOG is generated from these messages.

If new features/enhancement/fixes are added or changed:

  • Includes documentation updates (including updating the component's package.json for slot and event changes)
  • Includes any needed TypeScript declaration file updates
  • New/updated tests are included and passing (if required)
  • Existing test suites are passing
  • CodeCov for patch has met target
  • The changes have not impacted the functionality of other components or directives
  • ARIA Accessibility has been taken into consideration (Does it affect screen reader users or keyboard only users? Clickable items should be in the tab index, etc.)

If adding a new feature, or changing the functionality of an existing feature, the PR's
description above includes:

  • A convincing reason for adding this feature (to avoid wasting your time, it's best to open a suggestion issue first and wait for approval before working on it)
@jackmu95 jackmu95 requested a review from tmorehouse Jan 9, 2020
@jackmu95 jackmu95 added this to In progress in 2.3.0 via automation Jan 9, 2020
@codecov

This comment has been minimized.

Copy link

codecov bot commented Jan 9, 2020

Codecov Report

Merging #4584 into dev will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##              dev    #4584   +/-   ##
=======================================
  Coverage   99.92%   99.92%           
=======================================
  Files         251      251           
  Lines        5219     5219           
  Branches     1380     1380           
=======================================
  Hits         5215     5215           
  Misses          3        3           
  Partials        1        1

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f917bc3...a9bbfca. Read the comment docs.

@tmorehouse

This comment has been minimized.

Copy link
Member

tmorehouse commented Jan 9, 2020

In the examples, should we maybe allow minor semvers (which would save us from having to update the examples in the future)? e.g.

  "dependencies": {
    "bootstrap": "^4.4.1",
    "bootstrap-vue": "^2.2.0",
    "vue": "^2.6.11",
    "vuelidate": "^0.7.4"
  },

Otherwise, looks good.

@jackmu95

This comment has been minimized.

Copy link
Member Author

jackmu95 commented Jan 9, 2020

@tmorehouse Done.

@jackmu95 jackmu95 merged commit aca4a5c into dev Jan 9, 2020
9 checks passed
9 checks passed
License Compliance All checks passed.
Details
ci/circleci: build Your tests passed on CircleCI!
Details
ci/circleci: lint Your tests passed on CircleCI!
Details
ci/circleci: setup Your tests passed on CircleCI!
Details
ci/circleci: test Your tests passed on CircleCI!
Details
codecov/patch Coverage not affected when comparing f917bc3...a9bbfca
Details
codecov/project 99.92% remains the same compared to f917bc3
Details
deploy/netlify Deploy preview ready!
Details
security/snyk - package.json (pi0) No manifest changes detected
2.3.0 automation moved this from In progress to Done Jan 9, 2020
@jackmu95 jackmu95 deleted the feat-docs-improve-validation-examples branch Jan 9, 2020
@tmorehouse tmorehouse moved this from Done to v2.2.1 in 2.3.0 Jan 9, 2020
@tmorehouse tmorehouse changed the title feat(docs): improve form validation examples (closes #4550) docs: improve form validation examples (closes #4550) Jan 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.