fosdem2024_bigint: start adding multiplication section

[libreriscv.git] / HDL_workflow.mdwn

diff --git a/HDL_workflow.mdwn b/HDL_workflow.mdwn
index 92b64b9b9b3e58feb66e521a98583affae9b0cea..8e3472ffa19d44f09e8a02bb966384a27dc95dd7 100644 (file)
--- a/HDL_workflow.mdwn
+++ b/HDL_workflow.mdwn
@@ -341,12 +341,13 @@ relevant unit tests pass 100%.  This ensures that people's work does not
 get "lost" or isolated and out of touch due to major branch diversion,
 and that people communicate and coordinate with each other.
 
-This is not a hard rule: under special cirmstances branches can be useful.
+This is not a hard rule: under special circumstances 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,13 +896,19 @@ 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)
+and
+[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,
 or a subsystem/path, or a subsystem/subsubsystem combination, which got
 modified or introduced, and a short summary. These parts must be separated
-by the semicolon.
+by the colon.
 3. A good rule is to imagine that the short message begins with
 "if this patch is applied, it will". For example, a good title is
 "X: update Y", not "updated Y in X".
@@ -1297,6 +1304,11 @@ to me, because my background is in hardware not software engineering.
 
 # Task management guidelines
 
+* New guide for RfP submission (in-progress):
+[[HDL_workflow/rfp_submission_guide]]
+
+(This section needs to be compared with [[HDL_workflow/libresoc_bug_process]])
+
 1. Create the task in appropriate "Product" section with appropriate
   "Component" section. Most code tasks generally use "Libre-SOC's
   first SOC".