doc: prevent writing "topic:" to commit message
authorTomas Vanek <vanekt@fbl.cz>
Tue, 9 Nov 2021 18:22:29 +0000 (19:22 +0100)
committerTomas Vanek <vanekt@fbl.cz>
Tue, 17 May 2022 14:39:05 +0000 (14:39 +0000)
commit4d1b29313ace5b26687f75fb132c04f91cc1edcb
tree9bdb614db8c9a446d887d0ddd47aa824dfe9e2a7
parent830d70bfc66ada2a68c73283b9e4fa4770d408ee
doc: prevent writing "topic:" to commit message

First time contributors surprisingly often write "topic:"
instead of "the main part or subsystem the patch touches" as requested
in patchguide.html

To prevent them doing so:
Use longer self-explaing "specify touched area" instead of "topic"
Give some examples in addition to recommended looking at "git log"

Change-Id: I1c307b460d7a79ba3c9918af8dbc9e9f827e1fb9
Signed-off-by: Tomas Vanek <vanekt@fbl.cz>
Reviewed-on: https://review.openocd.org/c/openocd/+/6683
Reviewed-by: Antonio Borneo <borneo.antonio@gmail.com>
Tested-by: Paul Fertser <fercerpav@gmail.com>
HACKING