CONTRIBUTING.md 1.6 KB

Contribution Guidelines

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Please ensure your pull request adheres to the following guidelines:

  • Search previous suggestions before making a new one, as yours may be a duplicate.
  • Suggested additions should be related to Wagtail.
  • Suggested packages should be tested and documented.
  • Make an individual pull request for each suggestion.
  • Use the following format: [package](link) - Description.
  • Additions should be added to the bottom of the relevant category.
  • New categories, or improvements to the existing categorization are welcome.
  • Link to the GitHub repo, not pypi.
  • Keep descriptions short and simple, but descriptive.
  • Start the description with a capital and end with a full stop/period.
  • Check your spelling and grammar.
  • Wagtail should be referred to as "Wagtail" instead of "Wagtail CMS", with a capital W.
  • Make sure your text editor is set to remove trailing whitespace.
  • The pull request should have a useful title and include a link to the package and why it should be included.

Thank you for your suggestions!

Reusing the content

The content of this list is published as an API hosted on GitHub Pages: https://wagtail.github.io/awesome-wagtail/api/v1/readme.json.

Otherwise, directly access the Markdown README: README.md.