Add contributing/development pages (lensapp#1480)

jakolehm · web-flow · commit 4b4baf2d4b0c · 2020-11-23T11:37:30.000+02:00
Signed-off-by: Jari Kolehmainen &lt;jari.kolehmainen@gmail.com&gt;
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,132 @@
+# Contributor Covenant 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
+info@k8slens.dev.
+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][v2.0].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
+at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,3 @@
+# Contributing to Lens
+
+See [Contributing to Lens](https://docs.k8slens.dev/latest/contributing/) documentation.
diff --git a/Makefile b/Makefile
@@ -99,6 +99,10 @@ publish-npm: build-npm
 	npm config set '//registry.npmjs.org/:_authToken' "${NPM_TOKEN}"
 	cd src/extensions/npm/extensions && npm publish --access=public
 
+.PHONY: docs
+docs:
+	yarn mkdocs-serve-local
+
 .PHONY: clean-extensions
 clean-extensions:
 ifeq "$(DETECTED_OS)" "Windows"
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # Lens | The Kubernetes IDE
 
 [![Build Status](https://dev.azure.com/lensapp/lensapp/_apis/build/status/lensapp.lens?branchName=master)](https://dev.azure.com/lensapp/lensapp/_build/latest?definitionId=1&branchName=master)
-[![Releases](https://img.shields.io/github/downloads/lensapp/lens/total.svg)](https://github.com/lensapp/lens/releases)
+[![Releases](https://img.shields.io/github/downloads/lensapp/lens/total.svg)](https://github.com/lensapp/lens/releases?label=Downloads)
 [![Chat on Slack](https://img.shields.io/badge/chat-on%20slack-blue.svg?logo=slack&longCache=true&style=flat)](https://join.slack.com/t/k8slens/shared_invite/enQtOTc5NjAyNjYyOTk4LWU1NDQ0ZGFkOWJkNTRhYTc2YjVmZDdkM2FkNGM5MjhiYTRhMDU2NDQ1MzIyMDA4ZGZlNmExOTc0N2JmY2M3ZGI)
 
 World’s most popular Kubernetes IDE provides a simplified, consistent entry point for developers, testers, integrators, and DevOps, to ship code faster at scale.  Lens is the only IDE you’ll ever need to take control of your Kubernetes clusters. It is a standalone application for MacOS, Windows and Linux operating systems.  Lens is an open source project and free!
@@ -25,49 +25,12 @@ World’s most popular Kubernetes IDE provides a simplified, consistent entry po
 
 ## Installation
 
-Download a pre-built package from the [releases](https://github.com/lensapp/lens/releases) page. Lens can be also installed via [snapcraft](https://snapcraft.io/kontena-lens) (Linux only).
-
-Alternatively on Mac:
-```
-brew cask install lens
-```
+See [Getting Started](https://docs.k8slens.dev/latest/getting-started/) page.
 
 ## Development
 
-> Prerequisites: Nodejs v12, make, yarn
-
-* `make dev` - builds and starts the app
-* `make test` - run tests
-
-## Development (advanced)
-
-Allows for faster separate re-runs of some of the more involved processes:
-
-1. `yarn dev:main` compiles electron's main process app part
-1. `yarn dev:renderer` compiles electron's renderer app part
-1. `yarn dev:extension-types` compile declaration types for `@k8slens/extensions`
-1. `yarn dev-run` runs app in dev-mode and auto-restart when main process file has changed
-
-## Development (documentation)
-
-Run a local instance of `mkdocs serve` in a docker container for developing the Lens Documentation.
-
-> Prerequisites: docker, yarn
-
-* `yarn mkdocs-serve-local` - local build and serve of mkdocs with auto update enabled
-
-Go to [localhost:8000](http://127.0.0.1:8000)
-
-## Developer's ~~RTFM~~ recommended list:
-
-- [TypeScript](https://www.typescriptlang.org/docs/home.html) (front-end/back-end)
-- [ReactJS](https://reactjs.org/docs/getting-started.html) (front-end, ui)
-- [MobX](https://mobx.js.org/) (app-state-management, back-end/front-end)
-- [ElectronJS](https://www.electronjs.org/docs) (chrome/node)
-- [NodeJS](https://nodejs.org/dist/latest-v12.x/docs/api/) (api docs)
-
-
+See [Development](https://docs.k8slens.dev/latest/contributing/development/) page.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/lensapp/lens.
+See [Contributing](https://docs.k8slens.dev/latest/contributing/) page.
diff --git a/docs/contributing/development.md b/docs/contributing/development.md
@@ -1,3 +1,40 @@
 # Development
 
-TBD
+Thank you for taking the time to make a contribution to Lens. The following document is a set of guidelines and instructions for contributing to Lens.
+
+When contributing to this repository, please consider first discussing the change you wish to make by opening an issue.
+
+## Recommended Reading:
+
+- [TypeScript](https://www.typescriptlang.org/docs/home.html) (front-end/back-end)
+- [ReactJS](https://reactjs.org/docs/getting-started.html) (front-end, ui)
+- [MobX](https://mobx.js.org/) (app-state-management, back-end/front-end)
+- [ElectronJS](https://www.electronjs.org/docs) (chrome/node)
+- [NodeJS](https://nodejs.org/dist/latest-v12.x/docs/api/) (api docs)
+
+## Local Development Environment
+
+> Prerequisites: Nodejs v12, make, yarn
+
+* `make dev` - builds and starts the app
+* `make clean` - cleanup local environment build artifacts
+
+
+## Github Workflow
+
+We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), so all code changes are tracked via Pull Requests.
+A detailed guide on the recommended workflow can be found below:
+
+* [Github Workflow](./github_workflow.md)
+
+## Code Testing
+
+All submitted PRs go through a set of tests and reviews. You can run most of these tests *before* a PR is submitted.
+In fact, we recommend it, because it will save on many possible review iterations and automated tests.
+The testing guidelines can be found here:
+
+* [Contributor's Guide to Testing](./testing.md)
+
+## License
+
+By contributing, you agree that your contributions will be licensed as described in [LICENSE](https://github.com/lensapp/lens/blob/master/LICENSE).
diff --git a/docs/contributing/documentation.md b/docs/contributing/documentation.md
@@ -20,3 +20,14 @@ When you create a new pull request, we expect some requirements to be met.
   * When updating documentation, add `Update Documentation:` before the title. E.g. `Update Documentation: Getting Started`
 * If your Pull Request closes an issue, you must write `Closes #ISSUE_NUMBER` where the ISSUE_NUMBER is the number in the end of the link url or the relevent issue. This will link your pull request to the issue, and when it is merged, the issue will close.
 * For each pull request made, we run tests to check if there are any broken links, the markdown formatting is valid, and the linter is passing.
+
+
+## Testing Documentation Site Locally
+
+Run a local instance of `mkdocs` in a docker container for developing the Lens Documentation.
+
+> Prerequisites: docker, yarn
+
+* `make docs` - local build and serve of mkdocs with auto update enabled
+
+Go to [localhost:8000](http://127.0.0.1:8000).
diff --git a/docs/contributing/github_workflow.md b/docs/contributing/github_workflow.md
diff --git a/docs/contributing/testing.md b/docs/contributing/testing.md

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Contributing to Lens`
	`2`	`+`
	`3`	`+See [Contributing to Lens](https://docs.k8slens.dev/latest/contributing/) documentation.`