Skip to content

Commit 48b63a8

Browse files
authored
Add Key Contributor docs and links (#292)
1 parent c1ce262 commit 48b63a8

File tree

5 files changed

+128
-7
lines changed

5 files changed

+128
-7
lines changed

CODE_OF_CONDUCT.md

+76
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 [email protected]. 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

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Contributing to `React Hook Form` (The Docs)
2+
3+
As the creators and maintainers of this project, we want to ensure that `react-hook-form` 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/website.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. Startup a local version of the docs
18+
19+
> yarn start
20+
21+
5. Ensure your code is formatted properly
22+
23+
> yarn format
24+
25+
6. Push your branch: `git push -u origin your-meaningful-branch-name`
26+
27+
7. Submit a pull request to the upstream react-hook-form repository.
28+
29+
8. Choose a descriptive title and describe your changes briefly.
30+
31+
## Coding style
32+
33+
Please follow the coding style of the project. React Hook Form uses prettier. If possible, enable the prettier plugin in your editor to get real-time feedback. The formatting can be run manually with the following command: `yarn format`
34+
35+
## License
36+
37+
By contributing your code to the react-hook-form GitHub repository, you agree to license your contribution under the MIT license.

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ Thanks goes to these wonderful people. [[Become a contributor](https://github.co
2828
<img src="https://opencollective.com/react-hook-form/contributors.svg?width=950" />
2929
</a>
3030

31-
#### Thanks to
31+
#### Thanks to
3232

33-
* WebStorm for IDE license
34-
* ZEIT for free hosting
35-
* React ❤️
33+
- WebStorm for IDE license
34+
- Vercel for free hosting
35+
- React ❤️

src/components/Footer.tsx

+10-2
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,15 @@ export default ({ currentLanguage }: { currentLanguage: string }) => {
121121
>
122122
@github
123123
</a>
124-
️ ]
124+
️ ] [ Help make these doc's better{" "}
125+
<a
126+
href="https://github.com/react-hook-form/website"
127+
target="_blank"
128+
rel="noreferrer noopener"
129+
>
130+
@github
131+
</a>{" "}
132+
]
125133
</p>
126134
<p
127135
style={{
@@ -132,7 +140,7 @@ export default ({ currentLanguage }: { currentLanguage: string }) => {
132140
borderRadius: 4,
133141
}}
134142
>
135-
Hosted on ▲ ZEIT Now
143+
Hosted on ▲ Vercel Now
136144
</p>
137145
</footer>
138146
)

src/components/Nav.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ export default function Nav({ defaultLang }: { defaultLang: string }) {
3030
<div className={styles.iconGroup}>
3131
<span className={styles.icon}>
3232
<a
33-
href="https://github.com/bluebill1049/react-hook-form"
33+
href="https://github.com/react-hook-form"
3434
target="_blank"
3535
rel="noopener noreferrer"
3636
title="React Hook Form Github"

0 commit comments

Comments
 (0)