Browse Source

Updating readme on using PyLint

David Leonard 10 years ago
parent
commit
9026a59acb
1 changed files with 6 additions and 0 deletions
  1. 6 0
      README.md

+ 6 - 0
README.md

@@ -60,6 +60,12 @@ To run the tests:
 
 In order to write clean code with a consistent style guide, we'll be using `Pylint` to maintain our code. Pylint will display a ton of messages regarding things that should be fixed. 
 
+This project will use the camel-case naming convention for variables and function names, which PyLint complains about by default. As such, I have created a pylint configuration file within the home directory of the project (the same directory which contains `ionic`, `angular`, `hackathon_starter`.) To run pylint while supplying a pylint configuration file:
+
+    pylint --rcfile .pylintrc hackathon_starter/hackathon/scripts/github.py
+
+Where you can substitute `github.py` with the script you'd like to evaluate. 
+
 
 ## RESTful endpoints