From d4828d33b5aacee7c916861b36256d943703964e Mon Sep 17 00:00:00 2001 From: Chris Date: Sat, 25 May 2019 10:58:00 -0700 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5c31658..7cf57e0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -42,6 +42,13 @@ You can find the current release branch by checking out the [branches page](http * Make sure it works on both Python 2.7 and Python 3.x (this is often overlooked!) * Backwards compatibility must be honored +**When to PEP8:** + +The vast majority of Gooey's code does _not_ follow PEP8. This is because the vast majority of Gooey's code is build on top of WxPython code, which does not follow PEP8. Everything in Gooey's core honors the general camelCase style used throughout Wx. + +The exception to this rule is for everything in the `python_bindings/` package. This package holds the public API for Gooey, and thus honors PEP8. So the general rule is that if you're making a change to the public bindings: use PEP8. For all other internal Gooey code, honor the house style you find. + + ## Pull Request Process