|
Revision 325
(checked in by lawouach, 3 years ago)
|
Documentation book source commit (step 1)
|
| Line | |
|---|
| 1 |
<?xml version="1.0" encoding="utf-8"?> |
|---|
| 2 |
<section xmlns:db="http://docbook.org/docbook-ng" |
|---|
| 3 |
xmlns:xi="http://www.w3.org/2001/XInclude" |
|---|
| 4 |
xmlns:xsl="http://www.w3.org/1999/XSL/Transform" |
|---|
| 5 |
xml:id="codingstandards"> |
|---|
| 6 |
<title>Coding standards</title> |
|---|
| 7 |
<formalpara> |
|---|
| 8 |
<title>Guidelines for CherryPy Developers</title> |
|---|
| 9 |
|
|---|
| 10 |
CherryPy is an open source project. It means that all developers can contribute, but also, that everyone is |
|---|
| 11 |
responsible for the coding standards. To keep the source code in a consistent state, and to make sure that all tools |
|---|
| 12 |
work nicely, some guidelines must be adhered to: |
|---|
| 13 |
|
|---|
| 14 |
<itemizedlist> |
|---|
| 15 |
<listitem>Source code must be indented with 4 spaces, no tabs.</listitem> |
|---|
| 16 |
<listitem> |
|---|
| 17 |
Source files must use Unix-style LF line termination. This is required to avoid problems when using |
|---|
| 18 |
tools such as Subversion, which wrongly think that the entire file has changed if the line ends change. |
|---|
| 19 |
</listitem> |
|---|
| 20 |
<listitem> |
|---|
| 21 |
Source code must be kept less than 79 columns wide, whenever possible. Common sense should apply; sometimes it's |
|---|
| 22 |
acceptable to have a slightly longer, but more readable, line. Although not specifically required, PEP-8 |
|---|
| 23 |
compliance is desired. |
|---|
| 24 |
</listitem> |
|---|
| 25 |
</itemizedlist> |
|---|
| 26 |
</formalpara> |
|---|
| 27 |
</section> |
|---|
