TheArchive/zitadel
1
0
Fork 0
mirror of https://github.com/zitadel/zitadel.git synced 2025-05-30 15:28:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(contributing): use yarn instead of npm (#6233)

Browse Source
This commit is contained in:
Max Peintner 2023-07-19 14:32:33 +02:00 committed by GitHub
parent 59f3c328ec
commit 1c3a15ff57
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
CONTRIBUTING.md
View File

@ -1,4 +1,3 @@
# Contributing to ZITADEL # Contributing to ZITADEL
## Introduction ## Introduction
@ -234,7 +233,7 @@ Using [Docker Compose](https://docs.docker.com/compose/), you run [CockroachDB](
You use the ZITADEL container as backend for your console. You use the ZITADEL container as backend for your console.
The console is run in your [Node](https://nodejs.org/en/about/) environment using [a local development server for Angular](https://angular.io/cli/serve#ng-serve), so you have fast feedback about your changes. The console is run in your [Node](https://nodejs.org/en/about/) environment using [a local development server for Angular](https://angular.io/cli/serve#ng-serve), so you have fast feedback about your changes.
We use angular-eslint/Prettier for linting/formatting, so please run `npm run lint:fix` before committing. (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 angular-eslint/Prettier for linting/formatting, so please run `yarn lint:fix` before committing. (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)
Once you are happy with your changes, you run end-to-end tests and tear everything down. Once you are happy with your changes, you run end-to-end tests and tear everything down.
@ -282,16 +281,16 @@ You can run the local console development server now.
```bash ```bash
# Install npm dependencies # Install npm dependencies
npm install yarn install
# Generate source files from Protos # Generate source files from Protos
npm run generate yarn generate
# Start the server # Start the server
npm start yarn start
# If you don't want to develop against http://localhost:8080, you can use another environment # If you don't want to develop against http://localhost:8080, you can use another environment
ENVIRONMENT_JSON_URL=https://my-cloud-instance-abcdef.zitadel.cloud/ui/console/assets/environment.json npm start ENVIRONMENT_JSON_URL=https://my-cloud-instance-abcdef.zitadel.cloud/ui/console/assets/environment.json yarn start
``` ```
Navigate to http://localhost:4200/. Navigate to http://localhost:4200/.
@ -301,7 +300,7 @@ Open another shell.
```bash ```bash
# Reformat your console code # Reformat your console code
npm run lint:fix yarn lint:fix
# Change to the e2e directory # Change to the e2e directory
cd .. && cd e2e/ cd .. && cd e2e/
@ -348,7 +347,7 @@ Please refer to the [README](./docs/README.md) for more information and local te
### Style guide ### Style guide
- **Code with variables**: Make sure that code snippets can be used by setting environment variables, instead of manually replacing a placeholder. - **Code with variables**: Make sure that code snippets can be used by setting environment variables, instead of manually replacing a placeholder.
- **Embedded files**: When embedding mdx files, make sure the template ist prefixed by "_" (lowdash). The content will be rendered inside the parent page, but is not accessible individually (eg, by search). - **Embedded files**: When embedding mdx files, make sure the template ist prefixed by "\_" (lowdash). The content will be rendered inside the parent page, but is not accessible individually (eg, by search).
- **Don't repeat yourself**: When using the same content in multiple places, save and manage the content as separate file and make use of embedded files to import it into other docs pages. - **Don't repeat yourself**: When using the same content in multiple places, save and manage the content as separate file and make use of embedded files to import it into other docs pages.
- **Embedded code**: You can embed code snippets from a repository. See the [plugin](https://github.com/saucelabs/docusaurus-theme-github-codeblock#usage) for usage. - **Embedded code**: You can embed code snippets from a repository. See the [plugin](https://github.com/saucelabs/docusaurus-theme-github-codeblock#usage) for usage.
@ -427,7 +426,6 @@ Priority shows you the priority the ZITADEL team has given this issue. In genera
- **🏕 Medium**: After all the high issues are done these will be next. - **🏕 Medium**: After all the high issues are done these will be next.
- **🏝 Low**: This is low in priority and will probably not be implemented in the next time or just if someone has some time in between. - **🏝 Low**: This is low in priority and will probably not be implemented in the next time or just if someone has some time in between.
#### Complexity #### Complexity
This should give you an indication how complex the issue is. It's not about the hours or effort it takes. This should give you an indication how complex the issue is. It's not about the hours or effort it takes.
@ -461,4 +459,3 @@ The language shows you in which programming language the affected part is writte
- **lang: angular** - **lang: angular**
- **lang: go** - **lang: go**
- **lang: javascript** - **lang: javascript**