Styleguides

These are styleguides for working on Plone and the Plone ecosystem.

They not only apply to code, but also documentation, naming conventions and other areas.

• Python styleguide
  • Introduction
  • Line length
  • Indentation
  • Quoting
  • Docstrings style
  • Unit tests style
  • String formatting
  • About imports
  • Declaring dependencies
  • Versioning scheme
  • Concrete Rules
• JavaScript styleguide
  • Indentation
  • Naming of variables, classes and functions
• Styleguide for documentation
  • General style guides on documentation
  • Restructured Text versus Plain Text
  • Tracking changes
  • Git commit message style guide
• Naming Conventions
  • File Conventions
• Plone Deprecation Guide
  • Introduction
  • Enable Deprecation Warnings
  • Deprecation Best Practice
• How To Set Up Your Editor
  • dotfiles

Some of the information here is taken from the plone.api contributing guide