Contribute code

From Archivematica
(Difference between revisions)
Jump to: navigation, search
(Added coding standards.)
m (Standards: corrected formatting.)
Line 12: Line 12:
  
 
==Standards==
 
==Standards==
*Style Guide For Archivematica
+
 
 +
=== Code Style Guide For Archivematica ===
 
This coding convention is adopted from:
 
This coding convention is adopted from:
http://www.python.org/dev/peps/pep-0008/
+
<br/>http://www.python.org/dev/peps/pep-0008/
authors: Guido van Rossum <guido at python.org>, Barry Warsaw <barry at python.org>
+
<br/>authors: Guido van Rossum <guido at python.org>, Barry Warsaw <barry at python.org>
  
Tabs are forbidden.
+
*Tabs are forbidden.
4 spaces per indent.
+
*4 spaces per indent.
cammelCase all variables, starting with lower case.
+
*cammelCase all variables, starting with lower case.
Max 79 charactors per line.
+
*Max 79 charactors per line.
Each import is on it's own line (no comma seperated imports)
+
*Each import is on it's own line (no comma seperated imports)
No spaces next to parenthesis '('
+
*No spaces next to parenthesis '('
No space before comma, space after comma.
+
*No space before comma, space after comma.
Assignments and comparators are given a single space seperator 'x = 1'
+
*Assignments and comparators are given a single space seperator 'x = 1'
  
*File Structure
+
=== File Structure ===
The file structure in Archivematica will comply with the Filesystem Hierarchy Standard (FHS).
+
The file structure in Archivematica will comply with the Filesystem Hierarchy Standard (FHS).
More information on this standard is available at:
+
<br/>More information on this standard is available at:
http://www.pathname.com/fhs/
+
<br/>http://www.pathname.com/fhs/

Revision as of 15:39, 5 August 2010

Main Page > Development > Contribute code

Contents

Patches

If you find a bug in this project or would like to make an enhancement, please be encouraged to contribute a patch by following these instructions.

Commit access

Anyone can contribute code patches to this project. Project collaborators and regular patch contributors will be given access to commit directly to the Subversion code repository.

Copyright and license

You will retain copyright as the original author of any code that you write and contribute to the Archivematica project. However, in order to integrate your code into the Archivematica project, you need to release it under a GPL v2 license by following these instructions.

Standards

Code Style Guide For Archivematica

This coding convention is adopted from:
http://www.python.org/dev/peps/pep-0008/
authors: Guido van Rossum <guido at python.org>, Barry Warsaw <barry at python.org>

  • Tabs are forbidden.
  • 4 spaces per indent.
  • cammelCase all variables, starting with lower case.
  • Max 79 charactors per line.
  • Each import is on it's own line (no comma seperated imports)
  • No spaces next to parenthesis '('
  • No space before comma, space after comma.
  • Assignments and comparators are given a single space seperator 'x = 1'

File Structure

The file structure in Archivematica will comply with the Filesystem Hierarchy Standard (FHS).
More information on this standard is available at:
http://www.pathname.com/fhs/

Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox