Skip to content

Latest commit

 

History

History
44 lines (32 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

44 lines (32 loc) · 1.61 KB

Contribution Guidelines

Adding an entry

Please ensure your pull request adheres to the following guidelines:

  • Search previous suggestions before making a new one, as yours may be a duplicate.
  • Make an individual pull request for each suggestion.
  • Make sure to name the entry exactly as the original author intended, including any capitalization or lack thereof.
  • Use the following format: ![v3](img/vapor-3.png) ![v4](img/vapor-4.png) [Entry name](Entry URL) – Entry description.
    • The [v3](img/vapor-3.png) block declares Vapor 3 compatibility.
    • The [v4](img/vapor-4.png) block declares Vapor 4 compatibility.
    • The block contains the one and only allowed dash 😆.
    • The entry always ends with a full stop.
  • Link additions should be added in alphabetical order within a category.
  • New categories or improvements to the existing categorization are welcome.
  • Check your spelling and grammar.
  • Make sure your text editor is set to remove trailing whitespace.
  • The pull request and commit should have a useful title.

Thank you for your suggestions!

Deleting an entry

Typical reasons for deleting project:

  • Doesn’t build with current version of Swift
  • Doesn’t support Vapor 3 or later
  • No updates / no longer works
  • Deprecated

Thank you for keeping the list up-to-date!

Ineligible entries

Projects are ineligible if:

  • Lacks recent commit
  • Doesn’t support Vapor 3 or later
  • Doesn’t support Swift 5 or later
  • Isn’t written in English
  • README is not clear

Thank you for understanding! After all, this is a list of awesome things, so we as a community get to be picky!