Skip to content

Latest commit

 

History

History
38 lines (31 loc) · 1.7 KB

File metadata and controls

38 lines (31 loc) · 1.7 KB

Contribution Guidelines

Thank you for your suggestions!

Readmes

Please ensure your pull request adheres to the following guidelines:

  • Your pull request is for a project readme.
  • The focus of the description should be the readme rather than the project.
  • The description should be written by a person. Not AI.
  • Alphabetize your entry.
  • Search for previous suggestions before making a new one, as yours may be a duplicate.
  • Suggested READMEs should be visually appealing and unique.
  • Make an individual pull request for each suggestion.
  • Keep descriptions concise, simple, and clearly descriptive.
  • Start the description with a capital and end with a full stop/period.
  • Check your spelling and grammar.
  • Make sure your text editor is set to remove trailing whitespace.
  • Use the #readme anchor for GitHub READMEs to link them directly.
  • Ensure that links you add are active and not broken.

Tools

Please ensure your pull request adheres to the following guidelines:

  • The tool is aimed at project readmes, not profile readmes.
  • The tool has an established demand (i.e. a significant number of users, stars, etc).
  • The tool is a fully working solution that isn't new.
  • Alphabetize your entry.
  • Search for previous suggestions before making a new one, as yours may be a duplicate.
  • Make an individual pull request for each suggestion.
  • Keep descriptions concise, simple, and clearly descriptive.
  • Start the description with a capital and end with a full stop/period.
  • Check your spelling and grammar.
  • Make sure your text editor is set to remove trailing whitespace.
  • Use the #readme anchor for GitHub READMEs to link them directly.
  • Ensure that links you add are active and not broken.-