This is an automated email from the ASF dual-hosted git repository.
johnbodley pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/superset.git
The following commit(s) were added to refs/heads/master by this push:
new 9ef2861 Update CONTRIBUTING.md (#17016)
9ef2861 is described below
commit 9ef2861fbde309f9df3c8045f49005caed93cd0d
Author: John Bodley <[email protected]>
AuthorDate: Thu Oct 7 10:38:40 2021 -0700
Update CONTRIBUTING.md (#17016)
---
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
