From d67436025fb74b6fc947077a425f8dd05a911b3a Mon Sep 17 00:00:00 2001 From: Takahiro Noguchi Date: Fri, 8 May 2026 18:26:27 -0500 Subject: [PATCH] Update README --- CONTRIBUTING.md | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5399762..36580bc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -43,20 +43,17 @@ Follow this same naming convention for supporting files linked into markdown doc See the [docs.amdc.dev repository](https://github.com/Severson-Group/docs.amdc.dev) as an example. -##### MATLAB / Simulink +##### MATLAB -Follow the Camel Case naming convention described in the [Knowledgebase's MATLAB article](https://github.com/Severson-Group/KnowledgeBase/blob/main/code/matlab/README.md#style-guidelines). +Follow the naming convention described in the [Knowledgebase's MATLAB article](https://github.com/Severson-Group/KnowledgeBase/blob/main/code/matlab/README.md#style-guidelines). -##### Python - -Follow the naming convention described in the [Knowledgebase's Python article](https://github.com/Severson-Group/KnowledgeBase/blob/main/code/python/README.md#style-guidelines), which is [snake case](https://en.wikipedia.org/wiki/Snake_case) for most file types. +##### Simulink -##### Software +Follow the naming convention described in the [Knowledgebase's Simulink article](https://github.com/Severson-Group/KnowledgeBase/blob/main/code/matlab/simulink.md#style-and-modeling-guidelines). -When committing software, use the naming convention of the software: +##### Python -- MATLAB naming convention is [listed here](code/matlab/README.md#style-guidelines) -- Python naming convention is [listed here](code/python/README.md#style-guidelines) +Follow the naming convention described in the [Knowledgebase's Python article](https://github.com/Severson-Group/KnowledgeBase/blob/main/code/python/README.md#style-guidelines), which is [snake case](https://en.wikipedia.org/wiki/Snake_case) for most file types. #### Large Files