From 91b80bee6baf43ab0e15934261165f4dfa1268ad Mon Sep 17 00:00:00 2001 From: Ruslan Arkhipau Date: Fri, 24 Jun 2022 21:25:38 -0700 Subject: [PATCH] chore(docs): add a note about commit message during Angular upgrades --- CONTRIBUTING.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2507210..d482966 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -39,7 +39,13 @@ In order for everything to go smooth, you'll need to check prerequisites first: After you did that, follow the below process: - Pushed the latest changes to upstream: `git push` - - use `feat(package): add Angular X support` for commit messages that upgrade Angular version + + - use the following commit message convension when updating Angular to a newer version: + > feat(package): add Angular N support + > + > BREAKING CHANGE: + > Angular v(N-1) is no longer supported with this version. Pin `ng-recaptcha` to `vM.x.x` to retain support for a previous Angular version + - Ensure that the build succeeds - To start with, make sure all the dependencies are up-to-date: `yarn && yarn clean` - Then you need to prepare a release.