From badfb04a2088b9f0a492184b80163e9dfa06dd0c Mon Sep 17 00:00:00 2001 From: Caijinglong Date: Tue, 14 May 2024 15:08:52 +0800 Subject: [PATCH] chore: Update CONTRIBUTING Signed-off-by: Caijinglong --- CONTRIBUTING.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5107eaa..a786c1a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -43,3 +43,20 @@ Please don't change CHANGELOG manually. All changes will read from the git commit log and automatically generate the CHANGELOG. Admins can use `melos version` to generate when before release. + +We need add type for the git commit message, like `feat: provide a new feature`. + +The type can be `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `chore`, `revert`. + +See [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for more information. + +Also see it in [angular](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#type). + +## Publish packages to pub.dev for admins + +Admins can use `melos version` to generate the version and publish it. + +1. Run `melos version` to generate the version. Or use `melos version --yes` to skip the version prompt. +2. Publish, have two ways: + 1. Run `melos publish` to publish the packages. + 2. Create a new release in GitHub, the GitHub Action will publish the packages.