From 599e4019075b80ca1ef1afe86241ffa08e672472 Mon Sep 17 00:00:00 2001 From: Marcin Maciaszczyk Date: Wed, 26 Sep 2018 08:02:57 +0200 Subject: [PATCH] Update docs and add maciaszczykm@ to sig-ui-leads (#3269) * Update contribution guidelines * Add maciaszczykm to sig-ui-leads * Add doc describing roles --- .github/CONTRIBUTING.md | 45 ++++++++++++++++------------- CONTRIBUTING.md | 23 --------------- OWNERS_ALIASES | 1 + ROLES.md | 63 +++++++++++++++++++++++++++++++++++++++++ SECURITY_CONTACTS | 1 + 5 files changed, 90 insertions(+), 43 deletions(-) delete mode 100644 CONTRIBUTING.md create mode 100644 ROLES.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 0fea20cbb..a4aa25a1b 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,21 +1,26 @@ -Want to contribute? Great! First, read this page. - -### Before you contribute -Before we can use your code, you must sign the -[Cloud Native Computing Foundation Contributor License Agreement](https://github.com/kubernetes/community/blob/master/CLA.md) -(CLA). The CLA is necessary mainly because you own the -copyright to your changes, even after your contribution becomes part of our -codebase, so we need your permission to use and distribute your code. We also -need to be sure of various other things—for instance, that you'll tell us if you -know that your code infringes on other people's patents. You don't have to sign -the CLA until after you've submitted your code for review and a member has -approved it, but you must do it before we can put your code into our codebase. -Before you start working on a larger contribution, you should get in touch with -us first through the issue tracker with your idea so that we can help out and -possibly guide you. Coordinating up front makes it much easier to avoid -frustration later on. - -### Code reviews -All submissions, including submissions by project members, require review. We -use [pull requests](https://help.github.com/articles/about-pull-requests/) for this purpose. +# Contributing Guidelines +All the contributions are done via GitHub. Please also read the Kubernetes contributors guide: +https://github.com/kubernetes/community/blob/master/contributors/guide/README.md + +### Get familiar +To learn more about the project, please read through the following documents: + +- https://github.com/kubernetes/dashboard/wiki +- https://kubernetes.io/docs/tasks/access-application-cluster/web-ui-dashboard/ + +### Sign the CLA +Kubernetes projects require that you sign a Contributor License Agreement before we can accept your pull requests. Please see following document for more info: + +https://github.com/kubernetes/community/blob/master/CLA.md + +### Create a patch + +1. Submit an issue by describing your proposed change to the repo in question. +2. The repo owners will respond to your issue rapidly. +3. Fork the repo make your changes and test it. +4. Submit a pull request. + +### Get through review process + +All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 79d6cc774..000000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,23 +0,0 @@ -# Contributing Guidelines -The Kubernetes Dashboard Project is a web-based UI for Kubernetes clusters. It allows users to manage the cluster as well as applications running in the cluster. All the contribution is done via GitHub. Please also read the contributors guide: -https://github.com/kubernetes/community/blob/master/contributors/guide/README.md - -### Sign the CLA -Kubernetes projects require that you sign a Contributor License Agreement (CLA) before we can accept your pull requests. Please see https://github.com/kubernetes/community/blob/master/CLA.md for more info - -### Learn a bit about the Kubernetes Dashboard -To learn more about the Kubernetes Dashboard project, please read through the user documentation: -https://kubernetes.io/docs/tasks/access-application-cluster/web-ui-dashboard/ - -### Contributing A Patch - -1. Submit an issue by describing your proposed change to the repo in question. -2. The repo owners will respond to your issue rapidly. -3. Fork the repo make your changes and test it. -4. Submit a PR. - -### Code reviews - -All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. - - diff --git a/OWNERS_ALIASES b/OWNERS_ALIASES index 1e2d44efc..6f79fd05f 100644 --- a/OWNERS_ALIASES +++ b/OWNERS_ALIASES @@ -3,6 +3,7 @@ aliases: sig-ui-leads: - danielromlein - floreks + - maciaszczykm dashboard-maintainers: - konryd - ianlewis diff --git a/ROLES.md b/ROLES.md new file mode 100644 index 000000000..08e5ec534 --- /dev/null +++ b/ROLES.md @@ -0,0 +1,63 @@ +# Roles within Kubernetes Dashboard community + +This document describes the set of roles individuals may have within the Kubernetes Dashboard community. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionPeople
OwnerTakes part in strategic discussions. Involves only when needed.@bryk
AdministratorTakes care of repository settings, manages permissions and plugins.@floreks
LeadResponsible for design, plannings, roadmaps etc. Works on project recognition. + @danielromlein + @floreks + @maciaszczykm +
Tech leadTakes care of technical side of the project. Resolves technical issues and decisions. + @floreks + @maciaszczykm +
UX/UI leadTakes care of application look and feel. Resolves UX/UI issues and decisions.@danielromlein
SIG-UI leadLeads weekly meetings with the community. Integrates new members into community. + @danielromlein + @floreks + @maciaszczykm +
+ +### Rules + +- Members should remain active and responsive in their roles. diff --git a/SECURITY_CONTACTS b/SECURITY_CONTACTS index 961d9a4f1..20f55ce94 100644 --- a/SECURITY_CONTACTS +++ b/SECURITY_CONTACTS @@ -13,3 +13,4 @@ danielromlein floreks bryk +maciaszczykm -- GitLab