Commit 8d61a85f authored by Bruno Morgado's avatar Bruno Morgado Committed by Bruno S. Morgado
Browse files

Implement static code analysis 



Signed-off-by: default avatarBruno S. Morgado <jb.morgado@gmail.com>
parent 5821363b

README.md

+7 −1
Original line number Diff line number Diff line
@@ -21,3 +21,9 @@ Testing 
    - Inside this folder a rundown of the issues found will be accessible using the `index.html` file

* All the tests should pass before merging the code 

 

 Code analysis

 -------------

 * Use [Pylint](https://www.pylint.org) as the code analysis framework

 * By default it uses the [PEP8 style guide](Python's PEP8 style guide)

 * Use the provided `code-analysis.sh` script in order to run the code analysis in the `module` and `tests`

 * Code analysis should only raise document related warnings (i.e. `#FIXME` comments) before merging the code
 
 No newline at end of file

code-analysis.sh

0 → 100755
+9 −0
Original line number Diff line number Diff line 
#!/usr/bin/env bash

echo "STATIC CODE ANALYSIS"

echo



echo "Module analysis:"

pylint ska_skeleton



echo "Tests analysis:"

pylint tests

environment.yml

+2 −1
Original line number Diff line number Diff line
@@ -4,3 +4,4 @@ dependencies: 
  - setuptools

  - pytest

  - pytest-cov

  - pylint
 
 No newline at end of file

requirements.txt

+2 −1
Original line number Diff line number Diff line
@@ -2,3 +2,4 @@ pygments 
setuptools

pytest

pytest-cov

pylint
 
 No newline at end of file