You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@superset.apache.org by ma...@apache.org on 2019/10/23 04:44:18 UTC
[incubator-superset] branch master updated: docs: Add an
'Orientation' section to CONTRIBUTING.md (#8422)
This is an automated email from the ASF dual-hosted git repository.
maximebeauchemin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-superset.git
The following commit(s) were added to refs/heads/master by this push:
new cde17a8 docs: Add an 'Orientation' section to CONTRIBUTING.md (#8422)
cde17a8 is described below
commit cde17a8c9d229219fc11fece591f203399ddf9c3
Author: Maxime Beauchemin <ma...@gmail.com>
AuthorDate: Tue Oct 22 21:44:11 2019 -0700
docs: Add an 'Orientation' section to CONTRIBUTING.md (#8422)
---
CONTRIBUTING.md | 29 +++++++++++++++++++++++++++++
1 file changed, 29 insertions(+)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 0e4c5c5..4dbfcd5 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -24,6 +24,7 @@ little bit helps, and credit will always be given.
## Table of Contents
+- [Orientation](#orientation)
- [Types of Contributions](#types-of-contributions)
- [Report Bugs](#report-bugs)
- [Submit Ideas or Feature Requests](#submit-ideas-or-feature-requests)
@@ -54,6 +55,34 @@ little bit helps, and credit will always be given.
- [Merging DB migrations](#merging-db-migrations)
- [SQL Lab Async](#sql-lab-async)
+
+## Orientation
+
+Here's a list of repositories that contain Superset-related packages:
+
+- [apache/incubator-superset](https://github.com/apache/incubator-superset)
+ is the main repository containing the `apache-superset` Python package
+ distributed on
+ [pypi](https://pypi.org/project/apache-superset/). This repository
+ also includes Superset's main Javascript bundles and react apps under
+ the [superset/assets](https://github.com/apache/incubator-superset/tree/master/superset/assets)
+ folder.
+- [apache-superset/superset-ui](https://github.com/apache-superset/superset-ui)
+ contains core Superset's
+ [npm packages](https://github.com/apache-superset/superset-ui/tree/master/packages).
+ These packages are shared across the React apps in the main repository,
+ and in visualization plugins.
+- [apache-superset/superset-ui-plugins](https://github.com/apache-superset/superset-ui-plugins)
+ contains the code for the default visualizations that ship with Superset
+ and are maintained by the core community.
+- [apache-superset/superset-ui-plugins-deckgl](https://github.com/apache-superset/superset-ui-plugins-deckgl)
+ contains the code for the geospatial visualizations that ship with Superset
+ and are maintained by the core community.
+- [github.com/apache-superset](https://github.com/apache-superset) is the
+ Github organization under which we manage Superset-related
+ small tools, forks and Superset-related experimental ideas.
+
+
## Types of Contributions
### Report Bug