Skip to content

Latest commit

 

History

History
31 lines (25 loc) · 2.62 KB

pull_request_template.md

File metadata and controls

31 lines (25 loc) · 2.62 KB
Raw

[Insert URL to the list here.]

[Explain what this list is about and why it should be included here.]

By submitting this pull request I confirm I've read and complied with the below requirements.

Failure to properly do so will just result in the pull request being closed and everyone's time wasted. Please read it twice. Most people miss many things.

  • I have read and understood the contribution guidelines and the instructions for creating a list.
  • This pull request has a descriptive title. For example, Add Name of List, not Update readme.md or Add awesome list.
  • The entry in the Awesome list should include a short description about the list project/theme (not the list itself), and should be added at the bottom of the appropriate category.
  • The list I added
    • has been around for at least 30 days,
    • is the result of hard work and is the best I could possibly produce,
    • is a non-generated Markdown file in a GitHub repo,
    • is not a duplicate,
    • includes a succinct description of the project/theme at the top (example),
    • includes a project logo/illustration (whenever possible) at the top right of the readme (example). (The logo should link to the project website or any relevant website. The logo should be high-DPI, so set it to maximum half the width of the original image.),
    • only has awesome items with descriptions (Awesome lists are curations of the best, not of everything),
    • contains the awesome badge on the right side of the list heading,
    • has a Table of Contents section named Contents as the first section,
    • has an appropriate license (Meaning something like CC0, NOT a code licence like MIT, BSD, Apache, etc) (If you use a license badge, it should be SVG, not PNG),
    • has contribution guidelines,
    • doesn't include a Travis badge,
    • has been checked for inconsistent formatting, spelling, and grammar:
      • Each link description starts with an uppercase character and ends with a period.
      • Drop all the A / An prefixes in the descriptions.
      • Consistent naming. For example, Node.js, not NodeJS or node.js.