From 8dfeb65dc27ef68b294fa61d417eecc6d1208e33 Mon Sep 17 00:00:00 2001 From: Max Peintner Date: Fri, 19 May 2023 08:09:55 +0200 Subject: [PATCH 1/7] contributing --- CODE_OF_CONDUCT.md | 128 +++++++++++++++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 60 +++++++++++++++++++++ README.md | 5 ++ 3 files changed, 193 insertions(+) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000000..ac3f1296528 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# 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 +legal@zitadel.com. +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. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000000..239500acd3a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,60 @@ +# Contributing to ZITADEL-nextjs + +## Introduction + +Thank you for your interest about how to contribute! As you might know there is more than code to contribute. You can find all information needed to start contributing here. + +Please give us and our community the chance to get rid of security vulnerabilities by responsibly disclose this kind of issues by contacting [security@zitadel.com](mailto:security@zitadel.com). + +The strongest part of a community is the possibility to share thoughts. That's why we try to react as soon as possible to your ideas, thoughts and feedback. +We love to discuss as much as possible in an open space like in the ZITADEL [issues](https://github.com/zitadel/zitadel/issues) and [discussions](https://github.com/zitadel/zitadel/discussions) section or in our [chat](https://zitadel.com/chat), but we understand your doubts and provide further contact options [here](https://zitadel.com/contact). + +If you want to give an answer or be part of discussions please be kind. Treat others like you want to be treated. Read more about our code of conduct [here](CODE_OF_CONDUCT.md). + +## How to contribute + +Anyone can be a contributor. Either you found a typo, or you have an awesome feature request you could implement, we encourage you to create a Pull Request. + +### Pull Requests + +- The latest changes are always in `main`, so please make your Pull Request against that branch. +- Pull Requests should be raised for any change +- Pull Requests need approval of an ZITADEL core engineer @zitadel/engineers before merging +- We use ESLint/Prettier for linting/formatting, so please run `npm run lint:fix` before committing to make resolving conflicts easier (VSCode users, check out [this ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) and [this Prettier extension](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) to fix lint and formatting issues in development) +- We encourage you to test your changes, and if you have the opportunity, please make those tests part of the Pull Request +- If you add new functionality, please provide the corresponding documentation as well and make it part of the Pull Request + +### Setting up local environment + +A quick guide on how to setup your ZITADEL app locally to work on it and test out any changes: + +1. Clone the repo: + +```sh +git clone https://github.com/zitadel/zitadel-typescript.git +cd zitadel-typescript +``` + +3. Install packages. Developing requires Node.js v16: + +```sh +pnpm install +``` + +4. Populate `.env.local`: + +Copy `/apps/login/.env` to `/apps/login/.env.local`, and add your instance env variables for each entry. + +```sh +cp apps/login/.env apps/login/.env.local +``` + +5. Start the developer application/server: + +```sh +pnpm dev +``` + +The application will be available on `http://localhost:3000` + +That's it! 🎉 diff --git a/README.md b/README.md index d1d751dfb79..3d0650084be 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,11 @@ This is an monorepo containing all typescript/javascript packages and applications for ZITADEL. Versioning and package publishing is handled by [Changesets](https://github.com/changesets/changesets) and fully automated with GitHub Actions. +**⚠️ This repo and packages are in alpha state and subject to change ⚠️** + +The scope of functionality of this repo and packages is limited and under active development. +You can read the [contribution guide](/CONTRIBUTING.md) on how to contribute. Questions can be raised in our [Discord Channel](https://discord.gg/erh5Brh7jE) or as an issue in this repo. + ## What's inside? This Turborepo includes the following: From 444a7869ffbb66e063fc8bc5b526292db19b0770 Mon Sep 17 00:00:00 2001 From: Max Peintner Date: Fri, 19 May 2023 08:13:03 +0200 Subject: [PATCH 2/7] Create LICENSE --- LICENSE | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000000..89f750f2aba --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 ZITADEL + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. From e90fcda6370141c475b045c42710f7167c3e9cfd Mon Sep 17 00:00:00 2001 From: Max Peintner Date: Fri, 19 May 2023 08:15:27 +0200 Subject: [PATCH 3/7] contributing --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 239500acd3a..d5bca7c574c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# Contributing to ZITADEL-nextjs +# Contributing to zitadel-typescript ## Introduction From a371b7cd9fd43b7fd5560b303aae9776e0060779 Mon Sep 17 00:00:00 2001 From: Max Peintner Date: Fri, 19 May 2023 08:16:21 +0200 Subject: [PATCH 4/7] pnpm --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d5bca7c574c..d3a843fa887 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,7 +20,7 @@ Anyone can be a contributor. Either you found a typo, or you have an awesome fea - The latest changes are always in `main`, so please make your Pull Request against that branch. - Pull Requests should be raised for any change - Pull Requests need approval of an ZITADEL core engineer @zitadel/engineers before merging -- We use ESLint/Prettier for linting/formatting, so please run `npm run lint:fix` before committing to make resolving conflicts easier (VSCode users, check out [this ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) and [this Prettier extension](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) to fix lint and formatting issues in development) +- We use ESLint/Prettier for linting/formatting, so please run `pnpm lint:fix` before committing to make resolving conflicts easier (VSCode users, check out [this ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) and [this Prettier extension](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) to fix lint and formatting issues in development) - We encourage you to test your changes, and if you have the opportunity, please make those tests part of the Pull Request - If you add new functionality, please provide the corresponding documentation as well and make it part of the Pull Request From fcf7f83db7e8cd8cca7d7c4ee1e9a5c2df50035c Mon Sep 17 00:00:00 2001 From: Max Peintner Date: Fri, 19 May 2023 08:17:21 +0200 Subject: [PATCH 5/7] generate stub for login app --- CONTRIBUTING.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d3a843fa887..93c9fa33dd1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -49,7 +49,13 @@ Copy `/apps/login/.env` to `/apps/login/.env.local`, and add your instance env v cp apps/login/.env apps/login/.env.local ``` -5. Start the developer application/server: +5. Generate GRPC stub for the application: + +```sh +pnpm generate +``` + +6. Start the developer application/server: ```sh pnpm dev From e07acb173b83e0adaac4c6133804d76a468b0101 Mon Sep 17 00:00:00 2001 From: Max Peintner Date: Fri, 19 May 2023 08:32:11 +0200 Subject: [PATCH 6/7] Update CONTRIBUTING.md Co-authored-by: Fabi --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 93c9fa33dd1..709d4788cd7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,7 +19,7 @@ Anyone can be a contributor. Either you found a typo, or you have an awesome fea - The latest changes are always in `main`, so please make your Pull Request against that branch. - Pull Requests should be raised for any change -- Pull Requests need approval of an ZITADEL core engineer @zitadel/engineers before merging +- Pull Requests need approval of a ZITADEL core engineer @zitadel/engineers before merging - We use ESLint/Prettier for linting/formatting, so please run `pnpm lint:fix` before committing to make resolving conflicts easier (VSCode users, check out [this ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) and [this Prettier extension](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) to fix lint and formatting issues in development) - We encourage you to test your changes, and if you have the opportunity, please make those tests part of the Pull Request - If you add new functionality, please provide the corresponding documentation as well and make it part of the Pull Request From 33d99f03232dee5b449c88715747c2c8150977d2 Mon Sep 17 00:00:00 2001 From: Max Peintner Date: Fri, 19 May 2023 08:42:21 +0200 Subject: [PATCH 7/7] beta requirement --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 3d0650084be..a7a3f34c9a1 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ This is an monorepo containing all typescript/javascript packages and applicatio **⚠️ This repo and packages are in alpha state and subject to change ⚠️** The scope of functionality of this repo and packages is limited and under active development. +Once the package structure is set and all APIs are fully implemented we'll move this repo to beta state. You can read the [contribution guide](/CONTRIBUTING.md) on how to contribute. Questions can be raised in our [Discord Channel](https://discord.gg/erh5Brh7jE) or as an issue in this repo. ## What's inside?