From 847a32340da6ee439e8a9e2217c6ef1f1f86eaa1 Mon Sep 17 00:00:00 2001 From: Raul Marin Date: Wed, 8 Nov 2017 16:47:33 +0100 Subject: [PATCH] Update CONTRIBUTING with information about PG function labels --- CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 05e969e..e478427 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,6 +5,12 @@ refactoring or bugfixing, a topic branch must be created out of the `develop`. Modifications are done inside `src/pg/sql` and `src/py/crankshaft`. +When adding a new PostgreSQL function or modifying an exiting one make sure that the +[VOLATILITY](https://www.postgresql.org/docs/current/static/xfunc-volatility.html) and [PARALLEL](https://www.postgresql.org/docs/9.6/static/parallel-safety.html) categories are updated accordingly. +As PARALLEL labels need to be stripped for incompatible PostgreSQL versions +please use _PARALLEL SAFE/RESTRICTED/UNSAFE_ in uppercase so it's handled +automatically. + Take into account: * Tests must be added for any new functionality