erlang-punch/awesome-erlang
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
a653d1646b23d98967aefd59a9635e293ddf5b5d
awesome-erlang/CONTRIBUTING.md
David Robakowski a653d1646b Update contribution guidelines and add EditorConfig 
In order to avoid some kind a prioritization of some libraries and for
a better overview, I've updated the coding guidelines so that
the categories and category entries should be sorted alphabetically
from A-Z. The additional EditorConfig, copied from awesome-elixir,
will bring more code style consistence between different editors
and IDEs. Thanks @h4cc!
2015-01-27 13:00:16 +01:00

1.1 KiB
Raw Blame History

Contribution Guidelines

Please ensure your pull request adheres to the following guidelines:

  • Please search previous suggestions before making a new one, as yours may be a duplicate.
  • Libraries that are compatible with latest Erlang/OTP, tested and documented are preferred.
  • Please make an individual pull request for each suggestion.
  • Use the following format for libraries: [LIBRARY](LINK) - DESCRIPTION.
  • Prefix duplicate library names with their vendor or namespace followed by a space.
  • Keep descriptions short and simple.
  • End all descriptions with a full stop/period.
  • Check your spelling and grammar.
  • New categories, or improvements to the existing categorisation are welcome.
  • Category names have to be alphabetically sorted from A-Z.
  • Entry names inside categories have to be alphabetically sorted from A-Z.
  • Please use EditorConfig to ensure consistent line-endings, tabs/spaces, etc. or make sure, that your editor does satisfy the coding styles defined within .editorconfig.

Thank you for your suggestions!