Jump to: navigation, search

Difference between revisions of "Designate/Development/StyleGuide"

(Created page with "==== Designate Style Guide ==== {{note|This guide is unofficial at the moment}} Follow PEP8 and the [http://www.pocoo.org/internal/styleguide/ Pocoo Style Guide] Start new...")
 
(Designate Style Guide)
Line 1: Line 1:
 
==== Designate Style Guide ====
 
==== Designate Style Guide ====
  
{{note|This guide is unofficial at the moment}}
+
'''This guide is unofficial at the moment'''
  
Follow PEP8 and the [http://www.pocoo.org/internal/styleguide/ Pocoo Style Guide]
+
Follow [http://docs.openstack.org/developer/hacking/ OpenStack Style Guidelines] and the [http://www.pocoo.org/internal/styleguide/ Pocoo Style Guide]
  
 
Start new files with the following. Replace where needed:
 
Start new files with the following. Replace where needed:

Revision as of 12:19, 4 January 2016

Designate Style Guide

This guide is unofficial at the moment

Follow OpenStack Style Guidelines and the Pocoo Style Guide

Start new files with the following. Replace where needed:

# -*- coding: utf-8 -*-
# Copyright <year> <company>
#
# Author: <name> <email addr>
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.

"""
    <package.module>
    ~~~~~~~~~~~~~~
    <Describe what the module should do, especially interactions with other components>
    Specs: <Link to the spec document
"""