Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
206 lines (141 loc) · 6.57 KB

CONTRIBUTING.md

File metadata and controls

206 lines (141 loc) · 6.57 KB

Contributing

:attention: In this CONTRIBUTING.md you read about contributing to this very repository. If you want to develop your own login UI, please refer to the README.md.

Introduction

Thank you for your interest about how to contribute!

:attention: If you notice a possible security vulnerability, please don't hesitate to disclose any concern by contacting security@zitadel.com. You don't have to be perfectly sure about the nature of the vulnerability. We will give them a high priority and figure them out.

We also appreciate all your other ideas, thoughts and feedback and will take care of them as soon as possible. We love to discuss in an open space using GitHub issues, GitHub discussions in the core repo or in our chat on Discord. For private discussions, you have more contact options on our Website.

Pull Requests

Please consider the following guidelines when creating a pull request.

  • 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 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 and this Prettier extension to fix lint and formatting issues in development)
  • If you add new functionality, please provide the corresponding documentation as well and make it part of the pull request

Setting up local environment

# Install dependencies. Developing requires Node.js v20
pnpm install

# Generate gRPC stubs
pnpm generate

# Start a local development server for the login and manually configure apps/login/.env.local
pnpm dev

The application is now available at http://localhost:3000

Configure apps/login/.env.local to target the Zitadel instance of your choice. The login app live-reloads on changes, so you can start developing right away.

Developing Against A Local Latest Zitadel Release

The following command uses Docker to run a local Zitadel instance and the login application in live-reloading dev mode. Additionally, it runs a Traefik reverse proxy that exposes the login with a self-signed certificate at https://127.0.0.1.sslip.io 127.0.0.1.sslip.io is a special domain that resolves to your localhost, so it's safe to allow your browser to proceed with loading the page.

# Install dependencies. Developing requires Node.js v20
pnpm install

# Generate gRPC stubs
pnpm generate

# Start a local development server and have apps/login/.env.test.local configured for you to target the local Zitadel instance.
pnpm dev:local

Log in at https://127.0.0.1.sslip.io/ui/v2/login/loginname and use the following credentials: Loginname: zitadel-admin@zitadel.127.0.0.1.sslip.io Password: Password1!.

The login app live-reloads on changes, so you can start developing right away.

Developing Against A Locally Compiled Zitadel

To develop against a locally compiled version of Zitadel, you need to build the Zitadel docker image first. Clone the Zitadel repository and run the following command from its root:

# This compiles a Zitadel binary if it does not exist at ./zitadel already and copies it into a Docker image.
# If you want to recompile the binary, run `make compile` first
make login_dev

Open another terminal session at zitadel/zitadel/login and run the following commands to start the dev server.

# Install dependencies. Developing requires Node.js v20
pnpm install

# Start a local development server and have apps/login/.env.test.local configured for you to target the local Zitadel instance.
NODE_ENV=test pnpm dev

Log in at https://127.0.0.1.sslip.io/ui/v2/login/loginname and use the following credentials: Loginname: zitadel-admin@zitadel.127.0.0.1.sslip.io Password: Password1!.

The login app live-reloads on changes, so you can start developing right away.

Quality Assurance

Use make commands to test the quality of your code against a production build without installing any dependencies besides Docker. Using make commands, you can reproduce and debug the CI pipelines locally.

# Reproduce the whole CI pipeline in docker
make login_quality
# Show other options with make
make help

Use pnpm commands to run the tests in dev mode with live reloading and debugging capabilities.

Linting and formatting

Check the formatting and linting of the code in docker

make login_lint

Check the linting of the code using pnpm

pnpm lint
pnpm format

Fix the linting of your code

pnpm lint:fix
pnpm format:fix

Running Unit Tests

Run the tests in docker

make login_test_unit

Run unit tests with live-reloading

pnpm test:unit

Running Integration Tests

Run the test in docker

make login_test_integration

Alternatively, run a live-reloading development server with an interactive Cypress test suite. First, set up your local test environment.

# Install dependencies. Developing requires Node.js v20
pnpm install

# Generate gRPC stubs
pnpm generate

# Start a local development server and use apps/login/.env.test to use the locally mocked Zitadel API.
pnpm test:integration:setup

Now, in another terminal session, open the interactive Cypress integration test suite.

pnpm test:integration open

Show more options with Cypress

pnpm test:integration help

Running Acceptance Tests

To run the tests in docker against the latest release of Zitadel, use the following command:

⚠️ The acceptance tests are not reliable at the moment 🚧

make login_test_acceptance

Alternatively, run can use a live-reloading development server with an interactive Playwright test suite. Set up your local environment by running the commands either for developing against a local latest Zitadel release or for developing against a locally compiled Zitadel.

Now, in another terminal session, open the interactive Playwright acceptance test suite.

pnpm test:acceptance open

Show more options with Playwright

pnpm test:acceptance help