diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 888f2dccc..d3bd79a9f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,12 +10,12 @@ Your commits must meet the following criteria - It is signed. To learn how, check [this guide](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits). - It includes a `--sign-off` stanza. By doing this you state that you can certify [Developer Certificate of Origin](https://developercertificate.org). -- Its message tries to follow the Conventional Commits [guidelines](https://www.conventionalcommits.org/en/v1.0.0/>). +- Its message tries to follow the Conventional Commits [guidelines](https://www.conventionalcommits.org/en/v1.0.0). A commit then would look like ``` -git commit -S -s -m "" +git commit -S -s -m " NOTE: In development a `--insecure` flag must be provided to talk to the local APIs ``` -make -C app/cli -- auth login +go run --insecure app/cli/main.go auth login ``` You will get redirected to the pre-configured local OIDC provider (DEX) where there are two configured users - `sarah@chainloop.local`/`password` - `john@chainloop.local`/`password` + +Once logged in, you are ready to follow our [Getting Started guide](https://docs.chainloop.dev/getting-started/setup) diff --git a/docs/img/dev-env-overview.png b/docs/img/dev-env-overview.png new file mode 100644 index 000000000..aa54fc816 Binary files /dev/null and b/docs/img/dev-env-overview.png differ