Skip to content

Latest commit

 

History

History
28 lines (22 loc) · 2 KB

CONTRIBUTING.md

File metadata and controls

28 lines (22 loc) · 2 KB
Raw

Contribution Guidelines

Ensure your pull request adheres to the following guidelines:

  • Search previous suggestions before making a new one, as yours may be duplicated.
  • Don't open a Draft / WIP pull request while you work on the guidelines. A pull request should be 100% ready and adhere to all the guidelines when opening it.
  • Make an individual pull request for each suggestion.
  • The pull request title should be in the following format: Add Project Name
    • Add not add
  • The suggestion should be in English.
  • Use the following format: [Title](link) - Description.
  • Additions should be added to the bottom of the relevant category.
  • Keep descriptions short and simple but descriptive.
    • The description should not be a marketing tagline.
    • The description should not be a title case.
    • The description should not repeat the item title.
    • The description should start with a capital and end with a full stop/period.
  • Check your spelling and grammar. You can use ChatGPT for this!
  • New categories or improvements to the existing categorization are welcome but should be done in a separate pull request.
  • Use Asset Dump issue as a storage space for your archives, so that downloads are localised to GitHub repository and we avoid possible dead links. (Always ensure authors are okay with us hosting these files and give proper attribution to them)

Thank you for your suggestion!

Updating your PR

Often, making a PR adhere to the standards above can be difficult. If the maintainers notice anything we'd like changed, we'll ask you to edit your PR before merging it. If you're not sure how to do that, here is a guide on the different ways you can update your PR so that we can merge it.

(This document is based on the sindresorhus/awesome-chatgpt contribution guidelines document.)