Skip to content

Commit 339a4bd

Browse files
committed
Improved the code standards section of the readme
1 parent a24b9bc commit 339a4bd

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -82,10 +82,11 @@ flask {command} --help
8282
All DB commands are from the `Flask-Migrate` library and are used to configure DB migrations through Alembic. See their
8383
docs [here](https://flask-migrate.readthedocs.io/en/latest/) for details.
8484

85-
Code Standards
86-
------------
85+
## Code standards
86+
This project is configured to use Pylint. Commits will be pylinted by Travis CI and if the score drops your build will
87+
fail blocking you from merging. To make your life easier just run it before making a PR.
8788

88-
Use Pylint to ensure your code follows standards. Commits will be pylinted by Travis CI, if your
89-
build fails you must fix whatever it tells you is wrong before it will be merged.
90-
91-
To check locally, run ```pylint packet```
89+
To run pylint use this command:
90+
```bash
91+
pylint packet
92+
```

0 commit comments

Comments
 (0)