Update dev docs (visgl#4515)

jeffpeck10x · Apr 21, 2020 · 42f0962 · 42f0962
1 parent faa0d7d
commit 42f0962
Show file tree

Hide file tree

Showing 15 changed files with 73 additions and 924 deletions.
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -1,128 +1,3 @@
-# Contributor Covenant Code of Conduct
+# Code of Conduct
 
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, religion, or sexual identity
-and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our
-community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the
-  overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official e-mail address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-[INSERT CONTACT METHOD].
-All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series
-of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or
-permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including
-sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior,  harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within
-the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.0, available at
-https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct
-enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at
-https://www.contributor-covenant.org/translations.
+vis.gl is part of the [Urban Computing Foundation](https://uc.foundation/), supported by the Linux Foundation. Please be mindful of and adhere to the Linux Foundation's [Code of Conduct](https://lfprojects.org/policies/code-of-conduct/) when contributing to deck.gl.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,68 @@
+## Contributing to deck.gl
+
+**Thanks for taking the time to contribute!**
+
+PRs and bug reports are welcome, and we are actively looking for new maintainers.
+
+
+## Setting Up Dev Environment
+
+The **master** branch is the active development branch.
+
+Building deck.gl locally from the source requires node.js `10.x-12.12`.
+We use [yarn](https://yarnpkg.com/en/docs/install) to manage the dependencies of deck.gl.
+
+```bash
+git checkout master
+yarn bootstrap
+yarn test
+```
+
+Run the layer browser application:
+
+```bash
+cd examples/layer-browser
+yarn
+yarn start-local
+```
+
+If you consider opening a PR, here is some documentation to get you started:
+
+- vis.gl [developer process](https://www.github.com/visgl/tsc/tree/master/developer-process)
+- [deck.gl API design guidelines](/dev-docs/deckgl-api-guidelines.md)
+
+
+## Community Governance
+
+vis.gl is part of the [Urban Computing Foundation](https://uc.foundation/). See the organization's [Technical Charter](https://github.com/visgl/tsc/blob/master/Technical%20Charter.md).
+
+
+### Technical Steering Committee
+
+deck.gl development is governed by the vis.gl Technical Steering Committee (TSC). Current members:
+
+- [Ib Green](https://github.com/ibgreen)
+- [Xiaoji Chen](https://github.com/Pessimistress) - chairperson
+- [Tarek Sherif](https://github.com/tsherif)
+- [Ravi Akkenapally](https://github.com/1chandu)
+
+
+### Maintainers
+
+- [Andrew Duberstein](https://github.com/ajduberstein) - pydeck, json
+- [Xintong Xia](https://github.com/xintongxia) - layers
+- [Georgios Karnas](https://github.com/georgios-uber) - glTF
+- [Dario D'Amico](https://github.com/damix911) - ArcGIS
+- [Jesús Botella](https://github.com/jesusbotella) - MVT
+
+Maintainers of deck.gl have commit access to this GitHub repository, and take part in the decision making process.
+
+If you are interested in becoming a maintainer, read the [governance guidelines](https://github.com/visgl/tsc/tree/master/developer-process/governance.md).
+
+The vis.gl TSC meets monthly and publishes meeting notes via a [mailing list](https://lists.uc.foundation/g/visgl).
+This mailing list can also be utilized to reach out to the TSC.  
+
+
+## Code of Conduct
+
+Please be mindful of and adhere to the Linux Foundation's [Code of Conduct](https://lfprojects.org/policies/code-of-conduct/) when contributing to deck.gl.
diff --git a/README.md b/README.md
@@ -87,9 +87,8 @@ pip install pydeck
 
 ## Contributing
 
-Pull requests and bug reports are welcome, and all of deck.gl's roadmaps and feature planning is done openly on GitHub. Read the [developement guidelines](/dev-docs) to learn about our dev process.
+deck.gl is part of vis.gl, a [Urban Computing Foundation](https://uc.foundation/) project. Read the [contribution guidelines](/CONTRIBUTING.md) if you are intrested in contributing.
 
-Note that once your PR is about to be merged, you will be asked to register as a contributor by filling in a short form.
 
 ## Attributions
 

diff --git a/dev-docs/README.md b/dev-docs/README.md