Contribute code

From Archivematica
Revision as of 14:30, 19 February 2011 by Peter (talk | contribs)
Jump to navigation Jump to search

Main Page > Development > Contribute code


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.

Contributor's Agreement

In order to accept any patches or code commits, contributors must first sign the Archivematica Contributor's Agreement. One of the key challenges for open source software is to support a collaborative development environment while maintaining the software over the long term. Unifying Archivematica copyrights through contributor agreements is the best way to protect the availability and sustainability of Archivematica over the long-term as free and open-source software. In all cases, contributors who sign the Contributor's Agreement retain full rights to use their original contributions for any other purpose outside of Archivematica, while enabling Artefactual Systems, any successor Foundation which may eventually take over responsibility for Archivematica, and the wider Archivematica community to benefit from their collaboration and contributions in this open source project.

Trademark

Artefactual Systems owns the trademark

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 characters per line.
  • Each import is on it's own line (no comma separated imports)
  • No spaces next to parenthesis '('
  • No space before comma, space after comma.
  • Assignments and comparators are given a single space separator '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/