How we handle patches (mmoved): Difference between revisions

From OpenHatch wiki
Content added Content deleted
imported>Paulproteus
imported>Ktarnowski
(Added information on pep8 and pychecker tools.)
Line 1: Line 1:
{{Hacking OpenHatch}}
== As a patch submitter ==
== As a patch submitter ==


* File a bug on https://openhatch.org/bugs/ with a link to your code (for example, a git repository somewhere on the Internet, or with patch files as attachments in bug itself.)
* File a bug on https://openhatch.org/bugs/ with a link to your code (for example, a git repository somewhere on the Internet, or with patch files as attachments in bug itself.)
** If you opt for using git (which we recommend), please read https://github.com/diaspora/diaspora/wiki/Git-Workflow first
** If you generate patches and attach them, please do a few local commits and create the patch series with "git format-patch". (Read about [[How to generate patches with git format-patch]])
** If you generate patches and attach them, please do a few local commits and create the patch series with "git format-patch". (Read about [[How to generate patches with git format-patch]])
* Make sure your patch is of good quality. Write unit tests, use [http://pypi.python.org/pypi/PyChecker/0.8.12 PyChecker] and [http://pypi.python.org/pypi/pep8 pep8] tools; use comments and docstrings to explain things when necessary
* Join IRC and ping someone with deployment access (e.g., ''paulproteus'') until it gets reviewed
* Join IRC and ping someone with deployment access (e.g., ''paulproteus'') until it gets reviewed
* If it passes review, it should get deployed immediately.
* If it passes review, it should get deployed immediately.

== About your patches ==

* Required: You must update the copyright section at the top of the files you modified.
* Suggested: Your patch should probably have an accompanying set of tests so that we don't break your code down the line, by accident.

== As a reviewer ==

* Ping the author on IRC (or something) to see if she's/he's uploaded the most recent version.
* Ask the author to do this: "Please email devel@lists.openhatch.org saying that you're okay with your work being under AGPLv3. If you're willing, it'd be nice if you say 'the Affero GPL, version 3 or later, at your option'."

Revision as of 11:18, 23 February 2011

As a patch submitter

  • File a bug on https://openhatch.org/bugs/ with a link to your code (for example, a git repository somewhere on the Internet, or with patch files as attachments in bug itself.)
  • Make sure your patch is of good quality. Write unit tests, use PyChecker and pep8 tools; use comments and docstrings to explain things when necessary
  • Join IRC and ping someone with deployment access (e.g., paulproteus) until it gets reviewed
  • If it passes review, it should get deployed immediately.