Skip to content

Latest commit

 

History

History
29 lines (22 loc) · 1.41 KB

contributing.md

File metadata and controls

29 lines (22 loc) · 1.41 KB

Contribution Guidelines

Adding an add-on

Please ensure your pull request adheres to the requirements:

  • Make sure the add-on supports at least Plone 5.2 and/or 6 and also supports Python 3.
  • The add-on does not neeed to be released on pypi.
  • Make sure you've personally used or benefited from the suggested add-on.
  • Search through the previous pull requests before making a new one! 🙏
  • Make an individual pull request for each suggestion.
  • Use the following format: Add-on Title — description.
  • Expand on why the resource is useful in your pull request if needed.
  • Keep descriptions short and simple, but descriptive.
  • Adding new categories, or improving existing categories is welcome!
  • Double check your spelling and grammar! 😁
  • Keep entries sorts alphabetically by the title.

Thanks for contributing!

If you have something awesome to contribute to an awesome list, this is how you do it step-by-step.

You'll need a GitHub account!

  1. Access awesome-plones GitHub page. For example: https://github.com/collective/awesome-plone/
  2. Now click on the edit icon
  3. You can start editing the text of the file in the in-browser editor. Make sure you follow guidelines above. You can use GitHub Flavored Markdown.
  4. Say why you're proposing the add-on, and then click on "Propose file change".
  5. Submit the pull request!