docs: improve, help contributions

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,11 +1,17 @@
 
-Thank you for contributing to Flask-Appbuilder. 
+<!--- Thank you for contributing to Flask-Appbuilder. -->
+<!--- This repo uses a PR lint bot (https://github.com/apps/prlint), make sure to prefix your PR title with one of: -->
+<!--- build|chore|ci|docs|feat|fix|perf|refactor|style|test|other -->
 
-For Fixes:
+### Description
 
-Please, prefix the title with "Fix, " and describe in detail what you're fixing and the steps required to reproduce the problem.
-
-For new features:
-
-Please, prefix the title with "New, " and describe this new feature in detail, remember to update documentation.
+<!--- Describe the change below, including rationale and design decisions -->
 
+### ADDITIONAL INFORMATION
+<!--- Check any relevant boxes with "x" -->
+<!--- HINT: Include "Fixes #nnn" if you are fixing an existing issue -->
+- [ ] Has associated issue:
+- [ ] Changes UI
+- [ ] Requires DB Migration.
+- [ ] Introduces new feature or API
+- [ ] Removes existing feature or API

.github/prlint.json

@@ -0,0 +1,8 @@
+{
+  "title": [
+    {
+      "pattern": "^(build|chore|ci|docs|feat|fix|perf|refactor|style|test|other)((.+))?:\\s.+",
+      "message": "Your title needs to be prefixed with a topic."
+    }
+  ]
+}

CONTRIBUTING.rst

@@ -0,0 +1,32 @@
+# Contributing
+
+Contributions are very welcome and highly appreciated!
+
+## Setup you dev environment
+
+1 - First create a python development virtualenv
+
+``` bash
+$ python -m venv venv
+$ source venv/bin/activate
+$ pip install -r requirements.txt -r requirements-dev.txt
+```
+
+2 - Install `docker` and `docker-compose`
+
+## Run tests
+
+Contributions for new features or fixes should have tests associated. To verify that all tests are green you
+can run a subset of tests targeting only Postgres.
+
+1 - Start Postgres
+
+``` bash
+$ docker-compose up -d
+```
+
+2 - Run Postgres tests
+
+``` bash
+$ tox -e postgres
+```

docker-compose.yml

@@ -0,0 +1,14 @@
+version: "3.7"
+services:
+  postgres:
+    container_name: fab-postgres
+    image: postgres:10
+    restart: unless-stopped
+    env_file: .env
+    command: postgres -c 'max_connections=500'
+    environment:
+      POSTGRES_DB: app
+      POSTGRES_PASSWORD: pguserpassword
+      POSTGRES_USER: pguser
+    ports:
+      - 5432:5432

requirements-dev.txt

@@ -4,14 +4,7 @@ flake8==3.6.0
 nose==1.3.7
 pip-tools==3.5.0
 tox==3.5.3
-mongoengine>=0.7.10, <0.7.99
-flask-mongoengine==0.7.1
-pymongo>=2.8.1, <2.8.99
-Pillow>=7.0.0, <8.0.0
 mockldap>=0.3.0
 psycopg2-binary==2.7.5
-mysqlclient>=1.4.2, < 2.0.0
-cython==0.29.17
-pymssql==2.1.4
 black==19.3b0
 jmespath==0.9.5

requirements-extra.txt

@@ -0,0 +1,7 @@
+mongoengine>=0.7.10, <0.7.99
+flask-mongoengine==0.7.1
+pymongo>=2.8.1, <2.8.99
+Pillow>=7.0.0, <8.0.0
+mysqlclient>=1.4.2, < 2.0.0
+cython==0.29.17
+pymssql==2.1.4

tox.ini

@@ -11,7 +11,6 @@ deps =
     -rrequirements.txt
     -rrequirements-dev.txt
 
-
 [testenv:api-sqlite]
 setenv =
     SQLALCHEMY_DATABASE_URI = sqlite:///
@@ -21,6 +20,10 @@ commands =
 [testenv:mysql]
 setenv =
     SQLALCHEMY_DATABASE_URI = mysql://mysqluser:[email protected]/app?charset=utf8
+deps =
+    -rrequirements.txt
+    -rrequirements-dev.txt
+    -rrequirements-extra.txt
 commands =
     nosetests --stop -v --with-coverage --cover-package=flask_appbuilder flask_appbuilder.tests --ignore-files="test_mongoengine\.py"
 
@@ -33,10 +36,18 @@ commands =
 [testenv:mssql]
 setenv =
     SQLALCHEMY_DATABASE_URI = mssql+pymssql://sa:Password_123@localhost:1433/master
+deps =
+    -rrequirements.txt
+    -rrequirements-dev.txt
+    -rrequirements-extra.txt
 commands =
     nosetests --stop -v --with-coverage --cover-package=flask_appbuilder flask_appbuilder.tests --ignore-files="test_mongoengine\.py"
 
 [testenv:mongodb]
+deps =
+    -rrequirements.txt
+    -rrequirements-dev.txt
+    -rrequirements-extra.txt
 commands =
     nosetests --stop -v --with-coverage --cover-package=flask_appbuilder flask_appbuilder/tests/test_mongoengine.py