Skip to content

Latest commit

 

History

History
61 lines (36 loc) · 2.75 KB

CONTRIBUTING.md

File metadata and controls

61 lines (36 loc) · 2.75 KB

I’m really glad that you are interested in contributing to perlres !

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

This guide is inspired by awesome-perl 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 !)

Formatting

Example of Item of List

- :dancer: [Dancer](http://perldancer.org/) - Minimalist Web framework created by [Alexis Sukrieh](https://metacpan.org/author/SUKRIA)

Will produce :

Emojis

Take github emojis from this list

⚠️ Some emojis are not compatible with mobiles, please do not use them.

Emojis in titles

  • Categories (means ## :rocket: Second level title) should have an emoji
  • Sub Categories (means ### Third level title) should NOT have an emoji

Emojis in list items

Emojis related to item

Often emojis are related to the item : see for instance all CMS software where I use 📝 ✏️ 📋 and friends...

Another example of an emoji related to the software itself : ACT has a 💺 because it's related to conferences and people sitting in a room to listen talks.

We could have used the same emoji for all CMS, but having different one and putting them randomly looks prettier 😇

Emojis not related to item

Sometimes emojis does not always have a meaning at all and only respect a kind of "family".

Typical example is webframeworks that are generaly represented by animals 🐮 🐻 🐸 🐹 simply because I needed a lot of different emojis and they are so cool 😌

Tips

For the links, choose first the official website (if any) then the github repository then the metaCPAN

If you put official website first, you can provide a github link (or a metaCPAN link) at the end of the line.

Remember that this is not strictly a module list like Task::Kensho otherwise I would have chosen in priority the metaCPAN link

Quality Standard

This list is for people with a minimum Perl background

It can be used by people that do not know Perl at all (or very few) but you don't have to make this list fully accessible for these folks.

Old softwares could appear, even if not maintained for years, but only if they seems not completely dead.

Stay concise.