• plone.org
  • plone.com
  • training.plone.org
  • docs.plone.org
  • community.plone.org
PloneDocumentation
  • Documentation
  • Developing for Plone
  • Styleguides
  • Previous
  • Next
  • Introduction
  • Quickstart
  • Working with Content
  • Adapting & Extending Plone
  • Installing, Managing And Updating Plone
  • Developing for Plone
    • Developing add-ons for Plone
    • Programming with Plone
    • Debugging
    • Writing tests
    • The process for developing for Plone core
    • Plone style guides
      • Python styleguide
      • JavaScript styleguide
      • Styleguide for documentation
      • Naming Conventions
      • Plone Deprecation Guide
      • How To Set Up Your Editor
    • Importing content from other sources
    • Tutorials
    • Selected Plone core package documentation
  • Appendices
  • About
  • Asking for help
  • Unreleased
Contribute
  • Version: 5
  • Version: 4
  • Version: 3
  • About Plone Documentation versions
  • Version: 5
  • Version: 4
  • Version: 3
  • About Plone Documentation versions
Table Of Content

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

  • Documentation
  • Developing for Plone
  • Styleguides
  • Previous
  • Next
Further Help Resources:
  • Community Discussion
  • Stackoverflow
  • Online Chat
More Info On The Plone Project:
  • Plone Foundation
  • Success Stories
  • Providers & Consultants
About This Documentation:
  • Contribute
  • These Docs On GitHub
Install:
  • Plone
  • Plone Add-ons
Plone

The text and illustrations in this website are licensed by the Plone Foundation under a Creative Commons Attribution 4.0 International license. Plone and the Plone® logo are registered trademarks of the Plone Foundation, registered in the United States and other countries. For guidelines on the permitted uses of the Plone trademarks, see https://plone.org/foundation/logo All other trademarks are owned by their respective owners.

This page uses Google Analytics to collect statistics. You can disable it by blocking the JavaScript coming from www.google-analytics.com.