-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add files CONTRIBUTING.md, CODE_OF_CONDUCT.md and SECURITY.md
- Loading branch information
Showing
4 changed files
with
210 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,116 @@ | ||
# Code of Conduct - Env::Assert | ||
|
||
## Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as | ||
contributors and maintainers pledge to make 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 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 | ||
* 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 | ||
|
||
## Our Responsibilities | ||
|
||
Project maintainers 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. | ||
|
||
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, 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 <mikkoi@cpan.org>. | ||
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](https://contributor-covenant.org/), version | ||
[1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct/code_of_conduct.md) and | ||
[2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct/code_of_conduct.md), | ||
and was generated by [contributing-gen](https://github.com/bttger/contributing-gen). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
## HOW TO CONTRIBUTE | ||
|
||
Thank you for considering contributing to this distribution. This file | ||
contains instructions that will help you work with the source code. | ||
|
||
The distribution is managed with Dist::Zilla. This means than many of the | ||
usual files you might expect are not in the repository, but are generated at | ||
release time, as is much of the documentation. Some generated files are | ||
kept in the repository as a convenience (e.g. Makefile.PL or cpanfile). | ||
|
||
Generally, **you do not need Dist::Zilla to contribute patches**. You do need | ||
Dist::Zilla to create a tarball. See below for guidance. | ||
|
||
### Getting dependencies | ||
|
||
If you have App::cpanminus 1.6 or later installed, you can use `cpanm` to | ||
satisfy dependencies like this: | ||
|
||
$ cpanm --installdeps . | ||
|
||
Otherwise, look for either a `Makefile.PL` or `cpanfile` file for | ||
a list of dependencies to satisfy. | ||
|
||
### Running tests | ||
|
||
You can run tests directly using the `prove` tool: | ||
|
||
$ prove -l | ||
$ prove -lv t/some_test_file.t | ||
|
||
For most of my distributions, `prove` is entirely sufficient for you to test any | ||
patches you have. I use `prove` for 99% of my testing during development. | ||
|
||
### Code style and tidying | ||
|
||
Please try to match any existing coding style. If there is a `.perltidyrc` | ||
file, please install Perl::Tidy and use perltidy before submitting patches. | ||
|
||
If there is a `tidyall.ini` file, you can also install Code::TidyAll and run | ||
`tidyall` on a file or `tidyall -a` to tidy all files. | ||
|
||
### Patching documentation | ||
|
||
Much of the documentation Pod is generated at release time. Some is | ||
generated boilerplate; other documentation is built from pseudo-POD | ||
directives in the source like C<=method> or C<=func>. | ||
|
||
If you would like to submit a documentation edit, please limit yourself to | ||
the documentation you see. | ||
|
||
If you see typos or documentation issues in the generated docs, please | ||
email or open a bug ticket instead of patching. | ||
|
||
### Installing and using Dist::Zilla | ||
|
||
Dist::Zilla is a very powerful authoring tool, optimized for maintaining a | ||
large number of distributions with a high degree of automation, but it has a | ||
large dependency chain, a bit of a learning curve and requires a number of | ||
author-specific plugins. | ||
|
||
To install it from CPAN, I recommend one of the following approaches for | ||
the quickest installation: | ||
|
||
# using CPAN.pm, but bypassing non-functional pod tests | ||
$ cpan TAP::Harness::Restricted | ||
$ PERL_MM_USE_DEFAULT=1 HARNESS_CLASS=TAP::Harness::Restricted cpan Dist::Zilla | ||
|
||
# using cpanm, bypassing *all* tests | ||
$ cpanm -n Dist::Zilla | ||
|
||
In either case, it's probably going to take about 10 minutes. Go for a walk, | ||
go get a cup of your favorite beverage, take a bathroom break, or whatever. | ||
When you get back, Dist::Zilla should be ready for you. | ||
|
||
Then you need to install any plugins specific to this distribution: | ||
|
||
$ cpan `dzil authordeps` | ||
$ dzil authordeps | cpanm | ||
|
||
Once installed, here are some dzil commands you might try: | ||
|
||
$ dzil build | ||
$ dzil test | ||
$ dzil xtest | ||
|
||
You can learn more about Dist::Zilla at http://dzil.org/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# Security Policy | ||
|
||
If you discover a security issue, please bring it to our attention right away! | ||
|
||
## Reporting a Vulnerability | ||
|
||
Please **DO NOT** file a public issue to report a security vulberability, instead send your report privately to **mikkoi@cpan.org**. This will help ensure that any vulnerabilities that are found can be [disclosed responsibly](https://en.wikipedia.org/wiki/Responsible_disclosure) to any affected parties. |