Skip to content

Commit 5999d58

Browse files
committed
chore: project init
1 parent a2bbccc commit 5999d58

File tree

7 files changed

+243
-0
lines changed

7 files changed

+243
-0
lines changed

CODE_OF_CONDUCT.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
- Using welcoming and inclusive language
18+
- Being respectful of differing viewpoints and experiences
19+
- Gracefully accepting constructive criticism
20+
- Focusing on what is best for the community
21+
- Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
- The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
- Trolling, insulting/derogatory comments, and personal or political attacks
28+
- Public or private harassment
29+
- Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
- Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at bluebill1049@hotmail.com. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

CONTRIBUTING.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Contributing to `React Hook Form`
2+
3+
As the creators and maintainers of this project, we want to ensure that `codemod` lives and continues to grow and evolve. We would like to encourage everyone to help and support this library by contributing.
4+
5+
## Code contributions
6+
7+
Here is a quick guide to doing code contributions to the library.
8+
9+
1. Fork and clone the repo to your local machine `git clone https://github.com/YOUR_GITHUB_USERNAME/codemod.git`
10+
11+
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`
12+
13+
3. Install packages by running:
14+
15+
> yarn
16+
17+
4. If you've added a code that should be tested, ensure the test suite still passes.
18+
19+
> yarn test
20+
21+
5. Try to write some unit tests to cover as much of your code as possible.
22+
23+
6. Ensure your code lints without errors.
24+
25+
> yarn lint
26+
27+
7. Ensure build passes.
28+
29+
> yarn build
30+
31+
8. Push your branch: `git push -u origin your-meaningful-branch-name`
32+
33+
9. Submit a pull request to the upstream codemod repository.
34+
35+
10. Choose a descriptive title and describe your changes briefly.
36+
37+
## Coding style
38+
39+
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`
40+
41+
## License
42+
43+
By contributing your code to the codemod GitHub repository, you agree to license your contribution under the MIT license.
44+
45+
### Contributors
46+
47+
Thank you to all the people who have already contributed to React Hook Form!
48+
49+
<img src="https://opencollective.com/react-hook-form/contributors.svg?width=950" />

ISSUE_TEMPLATE/bug_report.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
---
8+
9+
**Describe the bug**
10+
A clear and concise description of what the bug is.
11+
12+
**To Reproduce**
13+
Steps to reproduce the behavior
14+
15+
**Expected behavior**
16+
A clear and concise description of what you expected to happen.
17+
18+
**Screenshots**
19+
If applicable, add screenshots to help explain your problem.
20+
21+
**Desktop (please complete the following information):**
22+
23+
- OS: [e.g. MacOs, Linux]
24+
- Node.js [e.g. 12, 14]
25+
26+
**Additional context**
27+
Add any other context about the problem here.

ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Ask a question
4+
url: https://github.com/react-hook-form/react-hook-form/discussions
5+
about: Ask questions and discuss with other community members

ISSUE_TEMPLATE/feature_request.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
---
8+
9+
**Is your feature request related to a problem? Please describe.**
10+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11+
12+
**Describe the solution you'd like**
13+
A clear and concise description of what you want to happen.
14+
15+
**Describe alternatives you've considered**
16+
A clear and concise description of any alternative solutions or features you've considered.
17+
18+
**Additional context**
19+
Add any other context or screenshots about the feature request here.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Fixes #
2+
3+
## Proposed Changes
4+
5+
-
6+
-
7+
-

README.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
<div align="center">
2+
<p align="center">
3+
<a href="https://react-hook-form.com" title="React Hook Form - Simple React forms validation">
4+
<img src="https://raw.githubusercontent.com/bluebill1049/react-hook-form/master/docs/logo.png" alt="React Hook Form Logo - React hook custom hook for form validation" width="300px" />
5+
</a>
6+
</p>
7+
</div>
8+
9+
<p align="center">Performant, flexible and extensible forms with easy to use validation.</p>
10+
11+
<div align="center">
12+
13+
[![npm downloads](https://img.shields.io/npm/dm/@hookform/codemod.svg?style=for-the-badge)](https://www.npmjs.com/package/@hookform/codemod)
14+
[![npm](https://img.shields.io/npm/dt/@hookform/codemod.svg?style=for-the-badge)](https://www.npmjs.com/package/@hookform/codemod)
15+
[![npm](https://img.shields.io/bundlephobia/minzip/@hookform/codemod?style=for-the-badge)](https://bundlephobia.com/result?p=@hookform/codemod)
16+
17+
</div>
18+
19+
## Goal
20+
21+
Migrate your React Hook Form codebase from older version to new without the hassle by using our codemod scrips
22+
23+
## Usage
24+
25+
`npx @hookform/codemod <transform> <path> [...options]`
26+
27+
- `transform` - name of transform, see available transforms below.
28+
- `path` - files or directory to transform
29+
- use the `--dry` option for a dry-run and use `--print` to print the output for comparison
30+
31+
This will start an interactive wizard, and then run the specified transform.
32+
33+
## Included transforms
34+
35+
### Migrate from V6 to V7
36+
37+
38+
## Backers
39+
40+
Thanks goes to all our backers! [[Become a backer](https://opencollective.com/react-hook-form#backer)].
41+
42+
<a href="https://opencollective.com/react-hook-form#backers">
43+
<img src="https://opencollective.com/react-hook-form/backers.svg?width=950" />
44+
</a>
45+
46+
## Organizations
47+
48+
Thanks goes to these wonderful organizations! [[Contribute](https://opencollective.com/react-hook-form/contribute)].
49+
50+
<a href="https://github.com/react-hook-form/react-hook-form/graphs/contributors">
51+
<img src="https://opencollective.com/react-hook-form/organizations.svg?width=950" />
52+
</a>
53+
54+
## Contributors
55+
56+
Thanks goes to these wonderful people! [[Become a contributor](CONTRIBUTING.md)].
57+
58+
<a href="https://github.com/react-hook-form/react-hook-form/graphs/contributors">
59+
<img src="https://opencollective.com/react-hook-form/contributors.svg?width=950" />
60+
</a>

0 commit comments

Comments
 (0)