From a82e940f7ab11fa150db8ef67aca36b2a558282f Mon Sep 17 00:00:00 2001 From: Luke Campagnola Date: Wed, 5 Mar 2014 11:01:53 -0500 Subject: [PATCH] Added instructions for contributing to pg --- CONTRIBUTING.txt | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 CONTRIBUTING.txt diff --git a/CONTRIBUTING.txt b/CONTRIBUTING.txt new file mode 100644 index 00000000..46790bac --- /dev/null +++ b/CONTRIBUTING.txt @@ -0,0 +1,47 @@ +Contributions to pyqtgraph are welcome! + +Please use the following guidelines when preparing changes: + +* The preferred method for submitting changes is by github pull request. If + this is inconvenient, don't hesitate to submit by other means. + +* Pull requests should include only a focused and related set of changes. + Mixed features and unrelated changes (such as .gitignore) will usually be + rejected. + +* For major changes, it is recommended to discuss your plans on the mailing + list or in a github issue before putting in too much effort. + + * Along these lines, please note that pyqtgraph.opengl will be deprecated + soon and replaced with VisPy. + +* Writing proper documentation and unit tests is highly encouraged. PyQtGraph + uses nose / py.test style testing, so tests should usually be included in a + tests/ directory adjacent to the relevant code. + +* Documentation is generated with sphinx; please check that docstring changes + compile correctly. + +* Style guidelines: + + * PyQtGraph prefers PEP8 for most style issues, but this is not enforced + rigorously as long as the code is clean and readable. + + * Exception 1: All variable names should use camelCase rather than + underscore_separation. This is done for consistency with Qt + + * Exception 2: Function docstrings use ReStructuredText tables for + describing arguments: + + ``` + ============== ======================================================== + **Arguments:** + argName1 (type) Description of argument + argName2 (type) Description of argument. Longer descriptions must + be wrapped within the column guidelines defined by the + "====" header and footer. + ============== ======================================================== + ``` + + QObject subclasses that implement new signals should also describe + these in a similar table.