sfirke commented on code in PR #28220: URL: https://github.com/apache/superset/pull/28220#discussion_r1581314233
########## docs/docs/contributing/contributing.mdx: ########## @@ -0,0 +1,141 @@ +--- +title: Contributing to Superset +sidebar_position: 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 ( +which can be joined by anyone): + +- [Mailing list](https://lists.apache.org/list.html?d...@superset.apache.org) +- [Apache Superset Slack community](http://bit.ly/join-superset-slack) +- [GitHub issues](https://github.com/apache/superset/issues) +- [GitHub pull requests](https://github.com/apache/superset/pulls) +- [GitHub discussions](https://github.com/apache/superset/discussions) +- [Superset Community Calendar](https://superset.apache.org/community) + +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) Review Comment: ```suggestion ``` Since that page now just points to this one. ########## docs/docs/contributing/contributing.mdx: ########## @@ -0,0 +1,141 @@ +--- +title: Contributing to Superset +sidebar_position: 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 ( +which can be joined by anyone): + +- [Mailing list](https://lists.apache.org/list.html?d...@superset.apache.org) +- [Apache Superset Slack community](http://bit.ly/join-superset-slack) +- [GitHub issues](https://github.com/apache/superset/issues) +- [GitHub pull requests](https://github.com/apache/superset/pulls) +- [GitHub discussions](https://github.com/apache/superset/discussions) +- [Superset Community Calendar](https://superset.apache.org/community) + +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) +- [Superset Wiki (code guidelines and additional resources)](https://github.com/apache/superset/wiki) + + +## Orientation + +Here's a list of repositories that contain Superset-related packages: + +- [apache/superset](https://github.com/apache/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 TypeScript/JavaScript bundles and react apps under + the [superset-frontend](https://github.com/apache/superset/tree/master/superset-frontend) + folder. +- [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 + +The best way to report a bug is to file an issue on GitHub. Please include: + +- Your operating system name and version. +- Superset version. +- Detailed steps to reproduce the bug. +- Any details about your local setup that might be helpful in troubleshooting. + +When posting Python stack traces, please quote them using +[Markdown blocks](https://help.github.com/articles/creating-and-highlighting-code-blocks/). + +_Please note that feature requests opened as GitHub Issues will be moved to Discussions._ + +### Submit Ideas or Feature Requests + +The best way is to start an ["Ideas" Discussion thread](https://github.com/apache/superset/discussions/categories/ideas) on GitHub: + +- Explain in detail how it would work. +- Keep the scope as narrow as possible, to make it easier to implement. +- Remember that this is a volunteer-driven project, and that your contributions are as welcome as anyone's :) + +To propose large features or major changes to codebase, and help usher in those changes, please create a **Superset Improvement Proposal (SIP)**. See template from [SIP-0](https://github.com/apache/superset/issues/5602) + +### Fix Bugs + +Look through the GitHub issues. Issues tagged with `#bug` are +open to whoever wants to implement them. + +### Implement Features + +Look through the GitHub issues. Issues tagged with +`#feature` is open to whoever wants to implement it. Review Comment: ```suggestion `#feature` are open to whoever wants to implement them. ``` ########## docs/docs/faq.mdx: ########## @@ -52,17 +50,17 @@ the result to users interacting with Superset. However, if you are using SQL Lab, there is no such limitation. You can write SQL queries to join multiple tables as long as your database account has access to the tables. -### How do I create my own visualization? +## How do I create my own visualization? We recommend reading the instructions in -[Creating Visualization Plugins](/docs/contributing/creating-viz-plugins). +[Creating Visualization Plugins](/docs/contributing/howtos#creating-visualization-plugins). -### Can I upload and visualize CSV data? +## Can I upload and visualize CSV data? Absolutely! Read the instructions [here](/docs/using-superset/exploring-data) to learn how to enable and use CSV upload. -### Why are my queries timing out? +## Why are my queries timing out? There are many reasons may cause long query timing out. Review Comment: ```suggestion There are many possible causes for why a long-running query might time out. ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: notifications-unsubscr...@superset.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: notifications-unsubscr...@superset.apache.org For additional commands, e-mail: notifications-h...@superset.apache.org
