GitHub-only

WARNING: If you are reading this on GitHub, DON'T! Read the documentation at docs.plone.org so you have working references and proper formatting.

How to contribute to this package?

Conventions

Rules and guidelines on syntax style, development process, repository workflow, etc.

• Conventions
  • Introduction
  • Line length
  • Indentation
  • Quoting
  • Docstrings style
  • Unit tests style
  • String formatting
  • About imports
  • Declaring dependencies
  • Versioning scheme
  • Restructured Text versus Plain Text
  • Tracking changes
  • Sphinx Documentation
  • Travis Continuous Integration
  • Git workflow & branching model
  • Release process for Plone packages
  • Setting up Git

Local development environment

Setting up and using the local development environment.

• Development environment
  • Locations of information and tools
  • Prerequisites
  • Creating and using the development environment
  • Working on an issue
  • Commit checklist

Releasing a new version

Description of our release process and guidelines.

• Releasing a new version
  • Checklist
  • Example