-
Notifications
You must be signed in to change notification settings - Fork 14.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Chore: moving charts and dashboard to docusaurus (#18036)
* add contributing add creating charts and dashboards * delete extra images
- Loading branch information
1 parent
0287f26
commit e406bf8
Showing
63 changed files
with
1,534 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"label": "Contributing", | ||
"position": 6 | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
--- | ||
name: General Resources | ||
menu: Contributing | ||
route: /docs/contributing/contribution-guidelines | ||
index: 1 | ||
version: 1 | ||
--- | ||
|
||
## Contributing to Superset | ||
|
||
Superset is an [Apache Software foundation](https://www.apache.org/theapacheway/index.html) project. | ||
The core contributors (or committers) to Superset communicate primarily in the following channels (all of | ||
which you can join): | ||
|
||
- [Mailing list](https://lists.apache.org/[email protected]) | ||
- [Apache Superset Slack community](https://join.slack.com/t/apache-superset/shared_invite/zt-uxbh5g36-AISUtHbzOXcu0BIj7kgUaw) | ||
- [Github issues and PR's](https://github.com/apache/superset/issues) | ||
|
||
More references: | ||
- [Comprehensive Tutorial for Contributing Code to Apache Superset](https://preset.io/blog/tutorial-contributing-code-to-apache-superset/) | ||
- [CONTRIBUTING Guide on Github](https://github.com/apache/superset/blob/master/CONTRIBUTING.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
--- | ||
title: Conventions and Typing | ||
hide_title: true | ||
sidebar_position: 7 | ||
version: 1 | ||
--- | ||
|
||
## Conventions | ||
|
||
### Python | ||
|
||
Parameters in the `config.py` (which are accessible via the Flask app.config dictionary) are assumed to always be defined and thus should be accessed directly via, | ||
|
||
```python | ||
blueprints = app.config["BLUEPRINTS"] | ||
``` | ||
|
||
rather than, | ||
|
||
```python | ||
blueprints = app.config.get("BLUEPRINTS") | ||
``` | ||
|
||
or similar as the later will cause typing issues. The former is of type `List[Callable]` whereas the later is of type `Optional[List[Callable]]`. | ||
|
||
## Typing | ||
|
||
### Python | ||
|
||
To ensure clarity, consistency, all readability, _all_ new functions should use | ||
[type hints](https://docs.python.org/3/library/typing.html) and include a | ||
docstring. | ||
|
||
Note per [PEP-484](https://www.python.org/dev/peps/pep-0484/#exceptions) no | ||
syntax for listing explicitly raised exceptions is proposed and thus the | ||
recommendation is to put this information in a docstring, i.e., | ||
|
||
```python | ||
import math | ||
from typing import Union | ||
|
||
|
||
def sqrt(x: Union[float, int]) -> Union[float, int]: | ||
""" | ||
Return the square root of x. | ||
:param x: A number | ||
:returns: The square root of the given number | ||
:raises ValueError: If the number is negative | ||
""" | ||
|
||
return math.sqrt(x) | ||
``` | ||
|
||
### TypeScript | ||
|
||
TypeScript is fully supported and is the recommended language for writing all new frontend components. When modifying existing functions/components, migrating to TypeScript is appreciated, but not required. Examples of migrating functions/components to TypeScript can be found in [#9162](https://github.com/apache/superset/pull/9162) and [#9180](https://github.com/apache/superset/pull/9180). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
--- | ||
title: Pre-commit Hooks and Linting | ||
hide_title: true | ||
sidebar_position: 6 | ||
version: 1 | ||
--- | ||
|
||
## Git Hooks | ||
|
||
Superset uses Git pre-commit hooks courtesy of [pre-commit](https://pre-commit.com/). To install run the following: | ||
|
||
```bash | ||
pip3 install -r requirements/integration.txt | ||
pre-commit install | ||
``` | ||
|
||
A series of checks will now run when you make a git commit. | ||
|
||
Alternatively it is possible to run pre-commit via tox: | ||
|
||
```bash | ||
tox -e pre-commit | ||
``` | ||
|
||
Or by running pre-commit manually: | ||
|
||
```bash | ||
pre-commit run --all-files | ||
``` | ||
|
||
## Linting | ||
|
||
### Python | ||
|
||
We use [Pylint](https://pylint.org/) for linting which can be invoked via: | ||
|
||
```bash | ||
# for python | ||
tox -e pylint | ||
``` | ||
|
||
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. | ||
|
||
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) | ||
|
||
### TypeScript | ||
|
||
```bash | ||
cd superset-frontend | ||
npm ci | ||
npm run lint | ||
``` | ||
|
||
If using the eslint extension with vscode, put the following in your workspace `settings.json` file: | ||
|
||
```json | ||
"eslint.workingDirectories": [ | ||
"superset-frontend" | ||
] | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,106 @@ | ||
--- | ||
title: Running a Local Flask Backend | ||
hide_title: true | ||
sidebar_position: 5 | ||
version: 1 | ||
--- | ||
|
||
### Flask server | ||
|
||
#### OS Dependencies | ||
|
||
Make sure your machine meets the [OS dependencies](https://superset.apache.org/docs/installation/installing-superset-from-scratch#os-dependencies) before following these steps. | ||
You also need to install MySQL or [MariaDB](https://mariadb.com/downloads). | ||
|
||
Ensure that you are using Python version 3.7 or 3.8, then proceed with: | ||
|
||
````bash | ||
# Create a virtual environment and activate it (recommended) | ||
python3 -m venv venv # setup a python3 virtualenv | ||
source venv/bin/activate | ||
|
||
# Install external dependencies | ||
pip install -r requirements/testing.txt | ||
|
||
# Install Superset in editable (development) mode | ||
pip install -e . | ||
|
||
# Initialize the database | ||
superset db upgrade | ||
|
||
# Create an admin user in your metadata database (use `admin` as username to be able to load the examples) | ||
superset fab create-admin | ||
|
||
# Create default roles and permissions | ||
superset init | ||
|
||
# Load some data to play with. | ||
# Note: you MUST have previously created an admin user with the username `admin` for this command to work. | ||
superset load-examples | ||
|
||
# Start the Flask dev web server from inside your virtualenv. | ||
# Note that your page may not have CSS at this point. | ||
FLASK_ENV=development superset run -p 8088 --with-threads --reload --debugger | ||
``` | ||
|
||
Or you can install via our Makefile | ||
|
||
```bash | ||
# Create a virtual environment and activate it (recommended) | ||
$ python3 -m venv venv # setup a python3 virtualenv | ||
$ source venv/bin/activate | ||
# install pip packages + pre-commit | ||
$ make install | ||
# Install superset pip packages and setup env only | ||
$ make superset | ||
# Setup pre-commit only | ||
$ make pre-commit | ||
```` | ||
**Note: the FLASK_APP env var should not need to be set, as it's currently controlled | ||
via `.flaskenv`, however if needed, it should be set to `superset.app:create_app()`** | ||
If you have made changes to the FAB-managed templates, which are not built the same way as the newer, React-powered front-end assets, you need to start the app without the `--with-threads` argument like so: | ||
`FLASK_ENV=development superset run -p 8088 --reload --debugger` | ||
#### Dependencies | ||
If you add a new requirement or update an existing requirement (per the `install_requires` section in `setup.py`) you must recompile (freeze) the Python dependencies to ensure that for CI, testing, etc. the build is deterministic. This can be achieved via, | ||
```bash | ||
$ python3 -m venv venv | ||
$ source venv/bin/activate | ||
$ python3 -m pip install -r requirements/integration.txt | ||
$ pip-compile-multi --no-upgrade | ||
``` | ||
#### Logging to the browser console | ||
This feature is only available on Python 3. When debugging your application, you can have the server logs sent directly to the browser console using the [ConsoleLog](https://github.com/betodealmeida/consolelog) package. You need to mutate the app, by adding the following to your `config.py` or `superset_config.py`: | ||
```python | ||
from console_log import ConsoleLog | ||
def FLASK_APP_MUTATOR(app): | ||
app.wsgi_app = ConsoleLog(app.wsgi_app, app.logger) | ||
``` | ||
Then make sure you run your WSGI server using the right worker type: | ||
```bash | ||
FLASK_ENV=development gunicorn "superset.app:create_app()" -k "geventwebsocket.gunicorn.workers.GeventWebSocketWorker" -b 127.0.0.1:8088 --reload | ||
``` | ||
You can log anything to the browser console, including objects: | ||
```python | ||
from superset import app | ||
app.logger.error('An exception occurred!') | ||
app.logger.info(form_data) | ||
``` | ||
### Frontend Assets | ||
See [Running Frontend Assets Locally](https://superset.apache.org/docs/installation/installing-superset-from-scratch#os-dependencies) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,96 @@ | ||
--- | ||
title: Pull Request Guidelines | ||
hide_title: true | ||
sidebar_position: 3 | ||
version: 1 | ||
--- | ||
|
||
## Pull Request Guidelines | ||
|
||
A philosophy we would like to strongly encourage is | ||
|
||
> Before creating a PR, create an issue. | ||
The purpose is to separate problem from possible solutions. | ||
|
||
**Bug fixes:** If you’re only fixing a small bug, it’s fine to submit a pull request right away but we highly recommend to file an issue detailing what you’re fixing. This is helpful in case we don’t accept that specific fix but want to keep track of the issue. Please keep in mind that the project maintainers reserve the rights to accept or reject incoming PRs, so it is better to separate the issue and the code to fix it from each other. In some cases, project maintainers may request you to create a separate issue from PR before proceeding. | ||
|
||
**Refactor:** For small refactors, it can be a standalone PR itself detailing what you are refactoring and why. If there are concerns, project maintainers may request you to create a `#SIP` for the PR before proceeding. | ||
|
||
**Feature/Large changes:** If you intend to change the public API, or make any non-trivial changes to the implementation, we require you to file a new issue as `#SIP` (Superset Improvement Proposal). This lets us reach an agreement on your proposal before you put significant effort into it. You are welcome to submit a PR along with the SIP (sometimes necessary for demonstration), but we will not review/merge the code until the SIP is approved. | ||
|
||
In general, small PRs are always easier to review than large PRs. The best practice is to break your work into smaller independent PRs and refer to the same issue. This will greatly reduce turnaround time. | ||
|
||
If you wish to share your work which is not ready to merge yet, create a [Draft PR](https://github.blog/2019-02-14-introducing-draft-pull-requests/). This will enable maintainers and the CI runner to prioritize mature PR's. | ||
|
||
Finally, never submit a PR that will put master branch in broken state. If the PR is part of multiple PRs to complete a large feature and cannot work on its own, you can create a feature branch and merge all related PRs into the feature branch before creating a PR from feature branch to master. | ||
|
||
### Protocol | ||
|
||
#### Authoring | ||
|
||
- Fill in all sections of the PR template. | ||
- Title the PR with one of the following semantic prefixes (inspired by [Karma](http://karma-runner.github.io/0.10/dev/git-commit-msg.html])): | ||
|
||
- `feat` (new feature) | ||
- `fix` (bug fix) | ||
- `docs` (changes to the documentation) | ||
- `style` (formatting, missing semi colons, etc; no application logic change) | ||
- `refactor` (refactoring code) | ||
- `test` (adding missing tests, refactoring tests; no application logic change) | ||
- `chore` (updating tasks etc; no application logic change) | ||
- `perf` (performance-related change) | ||
- `build` (build tooling, Docker configuration change) | ||
- `ci` (test runner, Github Actions workflow changes) | ||
- `other` (changes that don't correspond to the above -- should be rare!) | ||
- Examples: | ||
- `feat: export charts as ZIP files` | ||
- `perf(api): improve API info performance` | ||
- `fix(chart-api): cached-indicator always shows value is cached` | ||
|
||
- Add prefix `[WIP]` to title if not ready for review (WIP = work-in-progress). We recommend creating a PR with `[WIP]` first and remove it once you have passed CI test and read through your code changes at least once. | ||
- If you believe your PR contributes a potentially breaking change, put a `!` after the semantic prefix but before the colon in the PR title, like so: `feat!: Added foo functionality to bar` | ||
- **Screenshots/GIFs:** Changes to user interface require before/after screenshots, or GIF for interactions | ||
- Recommended capture tools ([Kap](https://getkap.co/), [LICEcap](https://www.cockos.com/licecap/), [Skitch](https://download.cnet.com/Skitch/3000-13455_4-189876.html)) | ||
- If no screenshot is provided, the committers will mark the PR with `need:screenshot` label and will not review until screenshot is provided. | ||
- **Dependencies:** Be careful about adding new dependency and avoid unnecessary dependencies. | ||
- For Python, include it in `setup.py` denoting any specific restrictions and in `requirements.txt` pinned to a specific version which ensures that the application build is deterministic. | ||
- For TypeScript/JavaScript, include new libraries in `package.json` | ||
- **Tests:** The pull request should include tests, either as doctests, unit tests, or both. Make sure to resolve all errors and test failures. See [Testing](#testing) for how to run tests. | ||
- **Documentation:** If the pull request adds functionality, the docs should be updated as part of the same PR. | ||
- **CI:** Reviewers will not review the code until all CI tests are passed. Sometimes there can be flaky tests. You can close and open PR to re-run CI test. Please report if the issue persists. After the CI fix has been deployed to `master`, please rebase your PR. | ||
- **Code coverage:** Please ensure that code coverage does not decrease. | ||
- Remove `[WIP]` when ready for review. Please note that it may be merged soon after approved so please make sure the PR is ready to merge and do not expect more time for post-approval edits. | ||
- If the PR was not ready for review and inactive for > 30 days, we will close it due to inactivity. The author is welcome to re-open and update. | ||
|
||
#### Reviewing | ||
|
||
- Use constructive tone when writing reviews. | ||
- If there are changes required, state clearly what needs to be done before the PR can be approved. | ||
- If you are asked to update your pull request with some changes there's no need to create a new one. Push your changes to the same branch. | ||
- The committers reserve the right to reject any PR and in some cases may request the author to file an issue. | ||
|
||
#### Test Environments | ||
|
||
- Members of the Apache GitHub org can launch an ephemeral test environment directly on a pull request by creating a comment containing (only) the command `/testenv up`. | ||
- Note that org membership must be public in order for this validation to function properly. | ||
- Feature flags may be set for a test environment by specifying the flag name (prefixed with `FEATURE_`) and value after the command. | ||
- Format: `/testenv up FEATURE_<feature flag name>=true|false` | ||
- Example: `/testenv up FEATURE_DASHBOARD_NATIVE_FILTERS=true` | ||
- Multiple feature flags may be set in single command, separated by whitespace | ||
- A comment will be created by the workflow script with the address and login information for the ephemeral environment. | ||
- Test environments may be created once the Docker build CI workflow for the PR has completed successfully. | ||
- Test environments do not currently update automatically when new commits are added to a pull request. | ||
- Test environments do not currently support async workers, though this is planned. | ||
- Running test environments will be shutdown upon closing the pull request. | ||
|
||
#### Merging | ||
|
||
- At least one approval is required for merging a PR. | ||
- PR is usually left open for at least 24 hours before merging. | ||
- After the PR is merged, [close the corresponding issue(s)](https://help.github.com/articles/closing-issues-using-keywords/). | ||
|
||
#### Post-merge Responsibility | ||
|
||
- Project maintainers may contact the PR author if new issues are introduced by the PR. | ||
- Project maintainers may revert your changes if a critical issue is found, such as breaking master branch CI. |
Oops, something went wrong.