From 7b793f3878f317c1d72d10887f743abb3ccb2b8d Mon Sep 17 00:00:00 2001 From: Andrey Miroshnikov Date: Tue, 5 Dec 2023 15:15:32 +0000 Subject: [PATCH] HDL_workflow: Update notes on git --- HDL_workflow.mdwn | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/HDL_workflow.mdwn b/HDL_workflow.mdwn index 92b64b9b9..cf0a19d02 100644 --- a/HDL_workflow.mdwn +++ b/HDL_workflow.mdwn @@ -344,9 +344,10 @@ and that people communicate and coordinate with each other. This is not a hard rule: under special cirmstances branches can be useful. They should not however be considered "routine". -For advice on commit messages see -[here](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html), -and [here](https://github.com/torvalds/subsurface-for-dirk/blob/master/README.md#contributing)). +For guidance on when branches are appropriate, +see [[HDL_workflow/libresoc_bug_process]]. + +For advice on commit messages see the Coding section further down on this page. ## yosys @@ -895,7 +896,13 @@ You can avoid damaging the repositories by following some simple procedures: ### *Git commit message format* -* Based on [bug #1126#c40](https://bugs.libre-soc.org/show_bug.cgi?id=1126#c40) +* Additional articles on commit messages: + - [here](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) + + - [here](https://github.com/torvalds/subsurface-for-dirk/blob/master/README.md#contributing)). + +* LibreSOC message format based on description given in +[bug #1126#c40](https://bugs.libre-soc.org/show_bug.cgi?id=1126#c40) 1. Every commit MUST start with a short title, up to 50 characters. 2. The commit title MUST contain either subsystem, or a file path, -- 2.30.2