Contribute code - Revision history

Rspencer: Update sphinx link

2020-07-15T23:32:52Z

Update sphinx link

2017-03-23T22:40:59Z

Add to process documentation category

2017-03-23T18:42:30Z

Patches: Move contents of pull requests page to section

2017-03-15T23:12:33Z

Link to contributing.md

2015-08-11T21:14:15Z

Code Style Guide For Archivematica: Tweaking

2015-08-11T21:07:25Z

Code Style Guide For Archivematica: Docstrings examples

2015-08-11T20:53:40Z

Code Style Guide For Archivematica: Update to reference external guidelines mostly

2013-09-23T21:32:38Z

Code Style Guide For Archivematica: pothole case instead of camel, updating import guidelines

2012-12-10T22:48:56Z

2012-11-27T00:58:14Z

Patches

@@ Line 32: / Line 32: @@
 * See also [https://github.com/artefactual/archivematica/pull/218 this pull request] and associated discussion.
-Example docstrings with Sphinx markup below. Other attributes that can be used in a docstring can be found [http://sphinx-doc.org/domains.html#the-python-domain on the Sphinx website].
+Example docstrings with Sphinx markup below. Other attributes that can be used in a docstring can be found [https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#python-signatures on the Sphinx website].
 <pre>def get_unit_status(unit_uuid, unit_type):

← Older revision		Revision as of 22:40, 23 March 2017
Line 2:		Line 2:

	Expanded contribution guidelines can also be found in the Archivematica [https://github.com/artefactual/archivematica/blob/qa/1.x/CONTRIBUTING.md contributing document].		Expanded contribution guidelines can also be found in the Archivematica [https://github.com/artefactual/archivematica/blob/qa/1.x/CONTRIBUTING.md contributing document].
		+
		+	[[Category:Process documentation]]

	==Patches==		==Patches==

@@ Line 4: / Line 4: @@
 ==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 [[Pull requests|these instructions]].
 ==Commit access==

← Older revision		Revision as of 23:12, 15 March 2017
Line 1:		Line 1:
	[[Main Page]] > [[Development]] > Contribute code		[[Main Page]] > [[Development]] > Contribute code

		+	Expanded contribution guidelines can also be found in the Archivematica [https://github.com/artefactual/archivematica/blob/qa/1.x/CONTRIBUTING.md contributing document].

	==Patches==		==Patches==

@@ Line 15: / Line 15: @@
 === Code Style Guide For Archivematica ===
-Archivematica follows common Python coding standards, notably
+Archivematica follows common Python coding standards, linked below.  We encourage installing a Python [http://stackoverflow.com/questions/8503559/what-is-linting linter] to help with this. [https://pypi.python.org/pypi/flake8 flake8] is recommended because it wraps three common linters (pep8, pyflakes, mccabe).
 * [https://www.python.org/dev/peps/pep-0008/ PEP8] for styling
 ** Exception is line length, which should be wrapped at 79 characters or left long for the IDE to wrap.
@@ Line 21: / Line 21: @@
 * [https://www.python.org/dev/peps/pep-0257/ PEP257] for docstring structure
 ** Parameters and return values should be specified in [http://sphinx-doc.org/domains.html#info-field-lists Sphinx-style].
+* See also [https://github.com/artefactual/archivematica/pull/218 this pull request] and associated discussion.
 Example docstrings with Sphinx markup below. Other attributes that can be used in a docstring can be found [http://sphinx-doc.org/domains.html#the-python-domain on the Sphinx website].

@@ Line 20: / Line 20: @@
 ** Imports are sorted alphabetically within their grouping to reduce duplicate imports
 * [https://www.python.org/dev/peps/pep-0257/ PEP257] for docstring structure
-** Parameters and return values should be specified in Sphinx-style.
+** Parameters and return values should be specified in [http://sphinx-doc.org/domains.html#info-field-lists Sphinx-style].
 We encourage installing a Python linter to help with this. [https://pypi.python.org/pypi/flake8 flake8] is recommended because it wraps three common linters (pep8, pyflakes, mccabe).
 * Install instructions for [https://github.com/SublimeLinter/SublimeLinter-flake8 SublimeLinter-flake8]
 === File Structure ===

@@ Line 20: / Line 20: @@
 *Tabs are forbidden.
 *4 spaces per indent.
-*camelCase all variables, starting with lower case.
+*pothole_case all variables, except for class names which are CamelCase (See PEP8 for details/clarifications)
 *Max 79 characters per line.
-*Each import is on it's own line (no comma separated imports)
+*Import grouped according to where they come from and sorted alphabetically, by import source
-*No spaces next to parenthesis '('
+<pre>
-*No space before comma, space after comma.
+# Example:
-*Assignments and comparators are given a single space separator 'x = 1'
+# stdlib, alphabetical by import source
 === File Structure ===