From 3f18b76f244c99ce8a0e2d11ad5d9834274d3091 Mon Sep 17 00:00:00 2001 From: Pavel Kosov Date: Wed, 3 May 2023 08:59:18 +0000 Subject: [PATCH] [Doc] Align development guide with wiki Add a requirement for issue link in a commit message Issue: https://gitee.com/openharmony/third_party_llvm-project/issues/I6ZYBW?from=project-issue Signed-off-by: Pavel Kosov --- OpenHarmonyDevelopmentGuidelines.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/OpenHarmonyDevelopmentGuidelines.md b/OpenHarmonyDevelopmentGuidelines.md index 03c5f62e21a9..29cfad2fa8be 100644 --- a/OpenHarmonyDevelopmentGuidelines.md +++ b/OpenHarmonyDevelopmentGuidelines.md @@ -32,7 +32,7 @@ or in case of multiline change: Some local OHOS change -// OHOS_LOCAL begin +// OHOS_LOCAL end ``` The presence of such marks greatly simplifies porting such code snippets to new LLVM versions. All such changes MUST be accompanied with a test case that MUST fail should the change is reverted. @@ -63,6 +63,16 @@ Commit message should briefly describe **how** it is achieved, e.g.: To support backward steps, auxiliary information is stored in SomeUsefulComponent ``` +Commit message should contain a link to related issue: + +``` +[lldb] Add support for backward debugging + +To support backward steps, auxiliary information is stored in SomeUsefulComponent + +Issue: https://gitee.com/openharmony/third_party_llvm-project/issues/I6ZYBW +``` + --------------------- ### ABI Breakage -- Gitee