Skip to content

Latest commit

 

History

History
37 lines (25 loc) · 866 Bytes

codingconventions.rst

File metadata and controls

37 lines (25 loc) · 866 Bytes
Raw
.. index:: codingconventions

Coding Conventions

Introduction

The following coding conventions are designed to ensure that the Socorro code is easy to read, hack, test, and deploy.

Style Guide

  • Python should follow PEP 8 with 4 space indents
  • PHP code follows the PEAR coding standard
  • JavaScript is indented by four spaces
  • :ref:`unittesting-chapter` is strongly encouraged

Review

New checkins that are non-trivial should be reviewed by one of the core hackers. The commit message should indicate the reviewer and the issue number if applicable.

Testing

Any features that are only available to admins should be tested to ensure that only non-admin users to not have access.

Before checking in changes to the socorro python code, be sure to run the unit tests.