diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 00000000..f7558e1d --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,5 @@ +# These are supported funding model platforms + +github: [bluebill1049, jorisre] +patreon: bluebill1049 +open_collective: react-hook-form diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..d96164ee --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,50 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: + +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Codesandbox link (Required)** +Include a codesandbox will help us to investigate the issue quicker. + +- [Yup resolver](https://codesandbox.io/s/react-hook-form-validationschema-v6-2l77g) Template +- [Zod resolver](https://codesandbox.io/s/react-hook-form-zod-resolver-example-forked-ko5ll) Template +- [Joi resolver](https://codesandbox.io/s/react-hook-form-joiresolver-v6-yejqe) Template +- [Superstruct resolver](https://codesandbox.io/s/react-hook-form-v6-superstructresolver-ed67i) Template +- [Vest resolver](https://codesandbox.io/s/vest-k6gbd) Template +- [Custom resolver](https://codesandbox.io/s/react-hook-form-customresoliver-v6-h4ti6) Template + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + +- OS: [e.g. iOS] +- Browser [e.g. chrome, safari] +- Version [e.g. 22] + +**Smartphone (please complete the following information):** + +- Device: [e.g. iPhone6] +- OS: [e.g. iOS8.1] +- Browser [e.g. stock browser, safari] +- Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..2af6816f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Ask a question + url: https://github.com/react-hook-form/react-hook-form/discussions + about: Ask questions and discuss with other community members diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..2f28cead --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,19 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/pull_request_template.md b/.github/ISSUE_TEMPLATE/pull_request_template.md new file mode 100644 index 00000000..b89b6ff4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/pull_request_template.md @@ -0,0 +1,7 @@ +Fixes # + +## Proposed Changes + +- +- +- diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index d87c2b5c..ee8e1f9a 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -3,6 +3,7 @@ on: push: branches: - master + - beta pull_request: paths-ignore: - '.gitignore' @@ -40,7 +41,7 @@ jobs: publish-module: name: 'Publish Module to NPM on Node ${{ matrix.node }} and ${{ matrix.os }}' needs: build - if: github.repository == 'react-hook-form/resolvers' && (github.ref =='refs/heads/master') + if: github.repository == 'react-hook-form/resolvers' && (github.ref == 'refs/heads/master' || github.ref == 'refs/heads/beta') runs-on: ubuntu-latest steps: - name: Checkout repo diff --git a/.gitignore b/.gitignore index f7cac5a3..51d65d9f 100644 --- a/.gitignore +++ b/.gitignore @@ -10,9 +10,6 @@ coverage # Dependency directories node_modules/ -app/node_modules/ -example/node_modules/ -example/build/ # Optional npm cache directory .npm @@ -27,11 +24,8 @@ example/build/ .yarn-integrity .DS_Store -/lib -/dist +dist .idea/ .rpt2_cache .coveralls.yml package-lock.json -/cypress/videos -/cypress/screenshots diff --git a/.vscode/settings.json b/.vscode/settings.json index 98a09f35..cbcd48c8 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -6,7 +6,6 @@ "typescriptreact" ], "prettier.configPath": "./.prettierrc", - "eslint.enable": true, "editor.formatOnSave": true, "editor.codeActionsOnSave": { "source.fixAll.eslint": true diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index 7ce97a74..00000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,7 +0,0 @@ -# @hookform/resolvers - -## 1.3.1 - -### Patch Changes - -- [`a7beb92`](https://github.com/react-hook-form/resolvers/commit/a7beb924686eb286e6c29dd766ddb56d0422d661) [#95](https://github.com/react-hook-form/resolvers/pull/95) Thanks [@benallfree](https://github.com/benallfree)! - esm support to fix bundler incompatibility diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..0fc387d2 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,76 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +- The use of sexualized language or imagery and unwelcome sexual attention or + advances +- Trolling, insulting/derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or electronic + address, without explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at bluebill1049@hotmail.com. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..26478c21 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,49 @@ +# Contributing to `React Hook Form` + +As the creators and maintainers of this project, we want to ensure that `resolvers` lives and continues to grow and evolve. We would like to encourage everyone to help and support this library by contributing. + +## Code contributions + +Here is a quick guide to doing code contributions to the library. + +1. Fork and clone the repo to your local machine `git clone https://github.com/YOUR_GITHUB_USERNAME/resolvers.git` + +2. Create a new branch from `master` with a meaningful name for a new feature or an issue you want to work on: `git checkout -b your-meaningful-branch-name` + +3. Install packages by running: + + > yarn + +4. If you've added a code that should be tested, ensure the test suite still passes. + + > yarn test + +5. Try to write some unit tests to cover as much of your code as possible. + +6. Ensure your code lints without errors. + + > yarn lint + +7. Ensure build passes. + + > yarn build + +8. Push your branch: `git push -u origin your-meaningful-branch-name` + +9. Submit a pull request to the upstream resolvers repository. + +10. Choose a descriptive title and describe your changes briefly. + +## Coding style + +Please follow the coding style of the project. React Hook Form uses eslint and prettier. If possible, enable their respective plugins in your editor to get real-time feedback. The linting can be run manually with the following command: `yarn lint` + +## License + +By contributing your code to the resolvers GitHub repository, you agree to license your contribution under the MIT license. + +### Contributors + +Thank you to all the people who have already contributed to React Hook Form! + + diff --git a/package.json b/package.json index 1fff1692..cd3bee6c 100644 --- a/package.json +++ b/package.json @@ -88,11 +88,6 @@ "peerDependencies": { "react-hook-form": ">=6.6.0" }, - "release": { - "branches": [ - "master" - ] - }, "husky": { "hooks": { "pre-commit": "yarn lint:types && lint-staged"