From 27f295674a7a27a5ee35acfd2412530cfd854fc7 Mon Sep 17 00:00:00 2001 From: Gao Sun Date: Wed, 20 Jul 2022 17:28:20 +0800 Subject: [PATCH] chore: update contributing guideline (#1625) * chore: update contributing guideline * chore: update contributing guideline title * refactor: apply suggestions from code review Co-authored-by: Xiao Yijun * chore: update contributing guideline Co-authored-by: Xiao Yijun --- .github/CONTRIBUTING.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index c9f2b8ec6..0d4968aee 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# (Draft) Contribute to Logto +# (Draft) Contribute to Logto monorepo Thanks for your interest in contributing to Logto. We respect the time of community contributors, so it'll be great if we can go through this guide which provides the necessary contribution information before starting your work. @@ -115,3 +115,11 @@ By default, Logto runs in `http://localhost:3001`, which will redirect you to th For now, `pnpm dev` only watches four packages: `core`, `ui`, `console`, and `demo-app`. If you changed other packages like connectors or schemas, you must stop the dev command and run again. Sorry for the inconvenience. We're working on a better dev command which watches all related packages. + +## Commit and create pull request + +We require every commit to [be signed](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits), and both the commit message and pull request title follow [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#summary). + +You can find repo-specific config in `commitlint.config.js`, if applicable. + +If the pull request remains empty content, it'll be DIRECTLY CLOSED until it matches our contributing guideline.