This is an automated email from the ASF dual-hosted git repository.
humbedooh pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-ponymail-foal.git
The following commit(s) were added to refs/heads/master by this push:
new 12c116d Begin work on a style guide for development. WIP
12c116d is described below
commit 12c116d3a624c49c1e28cdf5010dab4f31864df5
Author: Daniel Gruno <[email protected]>
AuthorDate: Thu Nov 18 18:09:06 2021 +0100
Begin work on a style guide for development. WIP
---
docs/STYLEGUIDE.md | 12 ++++++++++++
1 file changed, 12 insertions(+)
diff --git a/docs/STYLEGUIDE.md b/docs/STYLEGUIDE.md
new file mode 100644
index 0000000..80d88cf
--- /dev/null
+++ b/docs/STYLEGUIDE.md
@@ -0,0 +1,12 @@
+# Development style guide
+
+## ECMAScript Standards
+Foal uses ECMAScript 9th edition (2018) as the base scripting language for the
browser interface.
+All global variables must be declared with `G_` prepended, such as: `G_APIURL`
or `G_current_json`
+
+## Python Standards
+Foal requires Python 3.7 or above, following the PEP8 specifications with a
120 character maximum per line.
+
+Linting can be done using [Black](https://github.com/psf/black/): `black -l
120 foo.py`
+
+All code should be typed and is checked with
[mypy](https://github.com/python/mypy/)
