TheArchive/zitadel
1
0
Fork 0
mirror of https://github.com/zitadel/zitadel.git synced 2025-04-25 07:14:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: describe linting in the dev process (#4977)

Browse Source 
* docs: describe linting in the dev process

avoids forgetting to lint the code

* also lint e2e when developing console

* fix instruction sentence
This commit is contained in:
Elio Bischof 2023-01-04 14:59:36 +01:00 committed by GitHub
parent 35faa1b233
commit ec7f658264
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
CONTRIBUTING.md
View File

@ -158,6 +158,9 @@ goreleaser build --id prod --snapshot --single-target --rm-dist --output .artifa
# Pack the binary into a docker image # Pack the binary into a docker image
DOCKER_BUILDKIT=1 docker build --file build/Dockerfile .artifacts/zitadel -t zitadel:local DOCKER_BUILDKIT=1 docker build --file build/Dockerfile .artifacts/zitadel -t zitadel:local
# If you made changes in the e2e directory, make sure you reformat the files
(cd ./e2e && npm run lint:fix)
# Run the tests # Run the tests
ZITADEL_IMAGE=zitadel:local docker compose --file ./e2e/docker-compose.yaml run e2e ZITADEL_IMAGE=zitadel:local docker compose --file ./e2e/docker-compose.yaml run e2e
``` ```
@ -244,9 +247,15 @@ After making changes to the code, you should run the end-to-end-tests.
Open another shell. Open another shell.
```bash ```bash
# Reformat your console code
npm run lint:fix
# Change to the e2e directory # Change to the e2e directory
cd .. && cd e2e/ cd .. && cd e2e/
# If you made changes in the e2e directory, make sure you reformat the files here too
npm run lint:fix
# Install npm dependencies # Install npm dependencies
npm install npm install
@ -261,7 +270,7 @@ You can also open the test suite interactively for fast success feedback on spec
npm run open:dev npm run open:dev
``` ```
When you are happy with your changes, you can cleanup your environment When you are happy with your changes, you can format your code and cleanup your environment
```bash ```bash
# Stop and remove the docker containers for zitadel and the database # Stop and remove the docker containers for zitadel and the database