154 lines
6.4 KiB
Markdown
154 lines
6.4 KiB
Markdown
|
# Contributing
|
||
|
|
|
||
|
|
When contributing to this repository make sure to follow the Pull request process below.
|
||
|
|
Reduce to the minimum 3rd party dependencies.
|
||
|
|
|
||
|
|
Please note we have a [code of conduct](#Code of Conduct), please follow it in all your interactions with the project.
|
||
|
|
|
||
|
|
## Pull Request Process
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
1. Supported version is v3. If you are fixing a bug in v2, please port to v3
|
||
|
|
2. Use the title as a brief description of the changes
|
||
|
|
3. Describe the changes you are proposing
|
||
|
|
1. If adding an extra validation state the benefits of adding it and the problem is solving
|
||
|
|
2. Document in the readme, by adding it to the list
|
||
|
|
4. Provide appropriate tests for the code you are submitting: aim to keep the existing coverage percentage.
|
||
|
|
5. Add your Twitter handle (if you have) so we can thank you there.
|
||
|
|
|
||
|
|
## License
|
||
|
|
By contributing, you agree that your contributions will be licensed under its MIT License.
|
||
|
|
|
||
|
|
## Code of Conduct
|
||
|
|
|
||
|
|
### Our Pledge
|
||
|
|
|
||
|
|
We as members, contributors, and leaders pledge to make participation in our
|
||
|
|
community a harassment-free experience for everyone, regardless of age, body
|
||
|
|
size, visible or invisible 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.
|
||
|
|
|
||
|
|
We pledge to act and interact in ways that contribute to an open, welcoming,
|
||
|
|
diverse, inclusive, and healthy community.
|
||
|
|
|
||
|
|
### Our Standards
|
||
|
|
|
||
|
|
Examples of behavior that contributes to a positive environment for our
|
||
|
|
community include:
|
||
|
|
|
||
|
|
* Demonstrating empathy and kindness toward other people
|
||
|
|
* Being respectful of differing opinions, viewpoints, and experiences
|
||
|
|
* Giving and gracefully accepting constructive feedback
|
||
|
|
* Accepting responsibility and apologizing to those affected by our mistakes,
|
||
|
|
and learning from the experience
|
||
|
|
* Focusing on what is best not just for us as individuals, but for the
|
||
|
|
overall community
|
||
|
|
|
||
|
|
Examples of unacceptable behavior include:
|
||
|
|
|
||
|
|
* The use of sexualized language or imagery, and sexual attention or
|
||
|
|
advances of any kind
|
||
|
|
* Trolling, insulting or derogatory comments, and personal or political attacks
|
||
|
|
* Public or private harassment
|
||
|
|
* Publishing others' private information, such as a physical or email
|
||
|
|
address, without their explicit permission
|
||
|
|
* Other conduct which could reasonably be considered inappropriate in a
|
||
|
|
professional setting
|
||
|
|
|
||
|
|
### Enforcement Responsibilities
|
||
|
|
|
||
|
|
Community leaders are responsible for clarifying and enforcing our standards of
|
||
|
|
acceptable behavior and will take appropriate and fair corrective action in
|
||
|
|
response to any behavior that they deem inappropriate, threatening, offensive,
|
||
|
|
or harmful.
|
||
|
|
|
||
|
|
Community leaders 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, and will communicate reasons for moderation
|
||
|
|
decisions when appropriate.
|
||
|
|
|
||
|
|
### Scope
|
||
|
|
|
||
|
|
This Code of Conduct applies within all community spaces, and also applies when
|
||
|
|
an individual is officially representing the community in public spaces.
|
||
|
|
Examples of representing our community include using an official e-mail address,
|
||
|
|
posting via an official social media account, or acting as an appointed
|
||
|
|
representative at an online or offline event.
|
||
|
|
|
||
|
|
### Enforcement
|
||
|
|
|
||
|
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||
|
|
reported to the community leaders responsible for enforcement at <emailvalidatorrfc.ccreport@gmail.com>.
|
||
|
|
All complaints will be reviewed and investigated promptly and fairly.
|
||
|
|
|
||
|
|
All community leaders are obligated to respect the privacy and security of the
|
||
|
|
reporter of any incident.
|
||
|
|
|
||
|
|
#### Enforcement Guidelines
|
||
|
|
|
||
|
|
Community leaders will follow these Community Impact Guidelines in determining
|
||
|
|
the consequences for any action they deem in violation of this Code of Conduct:
|
||
|
|
|
||
|
|
#### 1. Correction
|
||
|
|
|
||
|
|
**Community Impact**: Use of inappropriate language or other behavior deemed
|
||
|
|
unprofessional or unwelcome in the community.
|
||
|
|
|
||
|
|
**Consequence**: A private, written warning from community leaders, providing
|
||
|
|
clarity around the nature of the violation and an explanation of why the
|
||
|
|
behavior was inappropriate. A public apology may be requested.
|
||
|
|
|
||
|
|
#### 2. Warning
|
||
|
|
|
||
|
|
**Community Impact**: A violation through a single incident or series
|
||
|
|
of actions.
|
||
|
|
|
||
|
|
**Consequence**: A warning with consequences for continued behavior. No
|
||
|
|
interaction with the people involved, including unsolicited interaction with
|
||
|
|
those enforcing the Code of Conduct, for a specified period of time. This
|
||
|
|
includes avoiding interactions in community spaces as well as external channels
|
||
|
|
like social media. Violating these terms may lead to a temporary or
|
||
|
|
permanent ban.
|
||
|
|
|
||
|
|
#### 3. Temporary Ban
|
||
|
|
|
||
|
|
**Community Impact**: A serious violation of community standards, including
|
||
|
|
sustained inappropriate behavior.
|
||
|
|
|
||
|
|
**Consequence**: A temporary ban from any sort of interaction or public
|
||
|
|
communication with the community for a specified period of time. No public or
|
||
|
|
private interaction with the people involved, including unsolicited interaction
|
||
|
|
with those enforcing the Code of Conduct, is allowed during this period.
|
||
|
|
Violating these terms may lead to a permanent ban.
|
||
|
|
|
||
|
|
#### 4. Permanent Ban
|
||
|
|
|
||
|
|
**Community Impact**: Demonstrating a pattern of violation of community
|
||
|
|
standards, including sustained inappropriate behavior, harassment of an
|
||
|
|
individual, or aggression toward or disparagement of classes of individuals.
|
||
|
|
|
||
|
|
**Consequence**: A permanent ban from any sort of public interaction within
|
||
|
|
the community.
|
||
|
|
|
||
|
|
### Attribution
|
||
|
|
|
||
|
|
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||
|
|
version 2.0, available at
|
||
|
|
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
|
||
|
|
|
||
|
|
Community Impact Guidelines were inspired by
|
||
|
|
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
|
||
|
|
|
||
|
|
For answers to common questions about this code of conduct, see the FAQ at
|
||
|
|
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
|
||
|
|
at [https://www.contributor-covenant.org/translations][translations].
|
||
|
|
|
||
|
|
[homepage]: https://www.contributor-covenant.org
|
||
|
|
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
|
||
|
|
[Mozilla CoC]: https://github.com/mozilla/diversity
|
||
|
|
[FAQ]: https://www.contributor-covenant.org/faq
|
||
|
|
[translations]: https://www.contributor-covenant.org/translations
|