You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@superset.apache.org by jo...@apache.org on 2021/10/07 16:21:57 UTC
[superset] 01/01: Update CONTRIBUTING.md
This is an automated email from the ASF dual-hosted git repository.
johnbodley pushed a commit to branch john-bodley-patch-3
in repository https://gitbox.apache.org/repos/asf/superset.git
commit 9e8a782a1537fa4313db2b8e99c9cfbea527a468
Author: John Bodley <45...@users.noreply.github.com>
AuthorDate: Thu Oct 7 09:19:59 2021 -0700
Update CONTRIBUTING.md
---
CONTRIBUTING.md | 13 +++++++++----
1 file changed, 9 insertions(+), 4 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 134cdef..494f381 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -650,18 +650,23 @@ pre-commit run --all-files
## Linting
-Lint the project with:
+### Python
+
+We use [Pylint](https://pylint.org/) for linting which can be invoked via:
```bash
# for python
tox -e pylint
+```
-Alternatively, you can use pre-commit (mentioned above) for python linting
+In terms of best practices please advoid blanket disablement of Pylint messages globally (via `.pylintrc`) or top-level within the file header, albeit there being a few exceptions. Disablement should occur inline as it prevents masking issues and provides context as to why said message is disabled.
-The Python code is auto-formatted using [Black](https://github.com/python/black) which
+Additionally the Python code is auto-formatted using [Black](https://github.com/python/black) which
is configured as a pre-commit hook. There are also numerous [editor integrations](https://black.readthedocs.io/en/stable/editor_integration.html)
-# for frontend
+### TypeScript
+
+```bash
cd superset-frontend
npm ci
npm run lint