Skip to content

Latest commit

 

History

History
41 lines (24 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

41 lines (24 loc) · 1.27 KB

I’m really glad that you are interested in contributing to awesome-perl!

First of all, respect great predecessors and all contributors in Perl community.

This guide is inspired by awesome-go Contribution Guidelines.

Contribution Guidelines

  • To add to the list: Submit a pull request
  • To remove from the list: Open an issue (you must describe a reason!)

In either case, it is desirable to contain following items in issue comment.

  • Motivation (e.g. why do you wanna add new item?)
  • Use case (e.g. situation)

And list must be sorted alphabetically.

Example of Item of List

* [Plack](https://metacpan.org/pod/Plack) - PSGI server implementation and utilities for Web applications.

It must contain a Name as link, a URL (it must be metacpan's one, and it must start with https://metacpan.org/pod) and a description.

Quality Standard

The most important thing is that this list is for people who do not know much about Perl5.

Therefore, modules in the list should meet the following quality standards.

  • Generally useful.
  • Stable or Actively maintained.
  • Installable from CPAN.
  • Has detailed manual and tutorial.

Rule

  • Add a few modules to one category in one pull-request.