diff --git a/.gitignore b/.gitignore index 9cc9f05..60b75e4 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,9 @@ # Ignoring shape predictor app/data/classifiers/*.dat +# redis dump db +dump.rdb + # Byte-compiled / optimized / DLL files __pycache__/ *.py[cod] diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..2f70fca --- /dev/null +++ b/.travis.yml @@ -0,0 +1,13 @@ +dist: xenial +language: python + +cache: pip +python: + - '3.7' + +install: + - pip install -r requirements.txt + - pip freeze + +script: + - pytest diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9b1724d..4e3b61e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,10 +1,68 @@ # Contributing to CSSI REST API -We would love for you to contribute to CSSI API and help make it even better than it is -today! +We would love for you to contribute to CSSI REST API and help make +it even better than it is today!. As a contributor, here are the +guidelines for you to follow: -### Type + - [Commit Message Guidelines](#commit) + - [Branch Naming Conventions](#branch-naming) + +## Commit Message Guidelines + +We have used `semantic git commits` through out the application and would like to keep them consistent. Please follow the following specified rules when committing your code. + +### Commit Message Format +Each commit message consists of a **header**, a **body** and a **footer**. The header has a special +format that includes a **type**, a **scope** and a **subject**: + +``` +(): + + + +