| 148 |
lars |
1 |
# Contributing
|
|
|
2 |
|
|
|
3 |
When contributing to this repository make sure to follow the Pull request process below.
|
|
|
4 |
Reduce to the minimum 3rd party dependencies.
|
|
|
5 |
|
|
|
6 |
Please note we have a [code of conduct](#Code of Conduct), please follow it in all your interactions with the project.
|
|
|
7 |
|
|
|
8 |
## Pull Request Process
|
|
|
9 |
|
|
|
10 |
When doing a PR to v2 remember that you also have to do the PR port to v3, or tests confirming the bug is not reproducible.
|
|
|
11 |
|
|
|
12 |
1. Supported version is v3. If you are fixing a bug in v2, please port to v3
|
|
|
13 |
2. Use the title as a brief description of the changes
|
|
|
14 |
3. Describe the changes you are proposing
|
|
|
15 |
1. If adding an extra validation state the benefits of adding it and the problem is solving
|
|
|
16 |
2. Document in the readme, by adding it to the list
|
|
|
17 |
4. Provide appropriate tests for the code you are submitting: aim to keep the existing coverage percentage.
|
|
|
18 |
5. Add your Twitter handle (if you have) so we can thank you there.
|
|
|
19 |
|
|
|
20 |
## License
|
|
|
21 |
By contributing, you agree that your contributions will be licensed under its MIT License.
|
|
|
22 |
|
|
|
23 |
## Code of Conduct
|
|
|
24 |
|
|
|
25 |
### Our Pledge
|
|
|
26 |
|
|
|
27 |
We as members, contributors, and leaders pledge to make participation in our
|
|
|
28 |
community a harassment-free experience for everyone, regardless of age, body
|
|
|
29 |
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
|
|
30 |
identity and expression, level of experience, education, socio-economic status,
|
|
|
31 |
nationality, personal appearance, race, religion, or sexual identity
|
|
|
32 |
and orientation.
|
|
|
33 |
|
|
|
34 |
We pledge to act and interact in ways that contribute to an open, welcoming,
|
|
|
35 |
diverse, inclusive, and healthy community.
|
|
|
36 |
|
|
|
37 |
### Our Standards
|
|
|
38 |
|
|
|
39 |
Examples of behavior that contributes to a positive environment for our
|
|
|
40 |
community include:
|
|
|
41 |
|
|
|
42 |
* Demonstrating empathy and kindness toward other people
|
|
|
43 |
* Being respectful of differing opinions, viewpoints, and experiences
|
|
|
44 |
* Giving and gracefully accepting constructive feedback
|
|
|
45 |
* Accepting responsibility and apologizing to those affected by our mistakes,
|
|
|
46 |
and learning from the experience
|
|
|
47 |
* Focusing on what is best not just for us as individuals, but for the
|
|
|
48 |
overall community
|
|
|
49 |
|
|
|
50 |
Examples of unacceptable behavior include:
|
|
|
51 |
|
|
|
52 |
* The use of sexualized language or imagery, and sexual attention or
|
|
|
53 |
advances of any kind
|
|
|
54 |
* Trolling, insulting or derogatory comments, and personal or political attacks
|
|
|
55 |
* Public or private harassment
|
|
|
56 |
* Publishing others' private information, such as a physical or email
|
|
|
57 |
address, without their explicit permission
|
|
|
58 |
* Other conduct which could reasonably be considered inappropriate in a
|
|
|
59 |
professional setting
|
|
|
60 |
|
|
|
61 |
### Enforcement Responsibilities
|
|
|
62 |
|
|
|
63 |
Community leaders are responsible for clarifying and enforcing our standards of
|
|
|
64 |
acceptable behavior and will take appropriate and fair corrective action in
|
|
|
65 |
response to any behavior that they deem inappropriate, threatening, offensive,
|
|
|
66 |
or harmful.
|
|
|
67 |
|
|
|
68 |
Community leaders have the right and responsibility to remove, edit, or reject
|
|
|
69 |
comments, commits, code, wiki edits, issues, and other contributions that are
|
|
|
70 |
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
|
|
71 |
decisions when appropriate.
|
|
|
72 |
|
|
|
73 |
### Scope
|
|
|
74 |
|
|
|
75 |
This Code of Conduct applies within all community spaces, and also applies when
|
|
|
76 |
an individual is officially representing the community in public spaces.
|
|
|
77 |
Examples of representing our community include using an official e-mail address,
|
|
|
78 |
posting via an official social media account, or acting as an appointed
|
|
|
79 |
representative at an online or offline event.
|
|
|
80 |
|
|
|
81 |
### Enforcement
|
|
|
82 |
|
|
|
83 |
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
|
84 |
reported to the community leaders responsible for enforcement at <emailvalidatorrfc.ccreport@gmail.com>.
|
|
|
85 |
All complaints will be reviewed and investigated promptly and fairly.
|
|
|
86 |
|
|
|
87 |
All community leaders are obligated to respect the privacy and security of the
|
|
|
88 |
reporter of any incident.
|
|
|
89 |
|
|
|
90 |
#### Enforcement Guidelines
|
|
|
91 |
|
|
|
92 |
Community leaders will follow these Community Impact Guidelines in determining
|
|
|
93 |
the consequences for any action they deem in violation of this Code of Conduct:
|
|
|
94 |
|
|
|
95 |
#### 1. Correction
|
|
|
96 |
|
|
|
97 |
**Community Impact**: Use of inappropriate language or other behavior deemed
|
|
|
98 |
unprofessional or unwelcome in the community.
|
|
|
99 |
|
|
|
100 |
**Consequence**: A private, written warning from community leaders, providing
|
|
|
101 |
clarity around the nature of the violation and an explanation of why the
|
|
|
102 |
behavior was inappropriate. A public apology may be requested.
|
|
|
103 |
|
|
|
104 |
#### 2. Warning
|
|
|
105 |
|
|
|
106 |
**Community Impact**: A violation through a single incident or series
|
|
|
107 |
of actions.
|
|
|
108 |
|
|
|
109 |
**Consequence**: A warning with consequences for continued behavior. No
|
|
|
110 |
interaction with the people involved, including unsolicited interaction with
|
|
|
111 |
those enforcing the Code of Conduct, for a specified period of time. This
|
|
|
112 |
includes avoiding interactions in community spaces as well as external channels
|
|
|
113 |
like social media. Violating these terms may lead to a temporary or
|
|
|
114 |
permanent ban.
|
|
|
115 |
|
|
|
116 |
#### 3. Temporary Ban
|
|
|
117 |
|
|
|
118 |
**Community Impact**: A serious violation of community standards, including
|
|
|
119 |
sustained inappropriate behavior.
|
|
|
120 |
|
|
|
121 |
**Consequence**: A temporary ban from any sort of interaction or public
|
|
|
122 |
communication with the community for a specified period of time. No public or
|
|
|
123 |
private interaction with the people involved, including unsolicited interaction
|
|
|
124 |
with those enforcing the Code of Conduct, is allowed during this period.
|
|
|
125 |
Violating these terms may lead to a permanent ban.
|
|
|
126 |
|
|
|
127 |
#### 4. Permanent Ban
|
|
|
128 |
|
|
|
129 |
**Community Impact**: Demonstrating a pattern of violation of community
|
|
|
130 |
standards, including sustained inappropriate behavior, harassment of an
|
|
|
131 |
individual, or aggression toward or disparagement of classes of individuals.
|
|
|
132 |
|
|
|
133 |
**Consequence**: A permanent ban from any sort of public interaction within
|
|
|
134 |
the community.
|
|
|
135 |
|
|
|
136 |
### Attribution
|
|
|
137 |
|
|
|
138 |
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
|
|
139 |
version 2.0, available at
|
|
|
140 |
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
|
|
|
141 |
|
|
|
142 |
Community Impact Guidelines were inspired by
|
|
|
143 |
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
|
|
|
144 |
|
|
|
145 |
For answers to common questions about this code of conduct, see the FAQ at
|
|
|
146 |
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
|
|
|
147 |
at [https://www.contributor-covenant.org/translations][translations].
|
|
|
148 |
|
|
|
149 |
[homepage]: https://www.contributor-covenant.org
|
|
|
150 |
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
|
|
|
151 |
[Mozilla CoC]: https://github.com/mozilla/diversity
|
|
|
152 |
[FAQ]: https://www.contributor-covenant.org/faq
|
|
|
153 |
[translations]: https://www.contributor-covenant.org/translations
|