diff --git a/login/.github/dependabot.yml b/login/.github/dependabot.example.yml similarity index 100% rename from login/.github/dependabot.yml rename to login/.github/dependabot.example.yml diff --git a/login/CONTRIBUTING.md b/login/CONTRIBUTING.md index 783935984f..50ca3172d1 100644 --- a/login/CONTRIBUTING.md +++ b/login/CONTRIBUTING.md @@ -20,6 +20,18 @@ you have [more contact options on our Website](https://zitadel.com/contact). ## Pull Requests +The repository zitadel/typescript is a read-only mirror of the git subtree at zitadel/zitadel/login. +To submit changes, please open a Pull Request [in the zitadel/zitadel repository](https://github.com/zitadel/zitadel/compare). + +If you already made changes based on the zitadel/typescript repository, these changes are not lost. +Submitting them to the main repository is easy: + +1. [Fork zitadel/zitadel](https://github.com/zitadel/zitadel/fork) +1. Clone your Zitadel fork git clone https://github.com//zitadel.git +1. Change directory to your Zitadel forks root. +1. Pull your changes into the Zitadel fork by running make login_pull LOGIN_REMOTE_URL=https://github.com//typescript.git LOGIN_REMOTE_BRANCH=. +1. Push your changes and [open a pull request to zitadel/zitadel](https://github.com/zitadel/zitadel/compare) + 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. diff --git a/login/README.md b/login/README.md index c3601e666b..21576dd119 100644 --- a/login/README.md +++ b/login/README.md @@ -23,6 +23,7 @@ a [GitHub issue](https://github.com/zitadel/typescript/issues). We think the easiest path of getting up and running, is the following: 1. Fork and clone this repository +1. Rename the file .github/dependabot.example.yml to .github/dependabot.yml so you don't miss version and security updates. 1. [Run the ZITADEL Cloud login UI locally](#run-login-ui) 1. Make changes to the code and see the effects live on your local machine 1. Study the rest of this README.md and get familiar and comfortable with how everything works.