Folders vs tags and releases in the repo/README #2
Description
Great to see these coding guidelines by MathWorks and supported by the Code Analyzer in R2025a onwards. I was reading the README.md and was a little confused. I read:
Each folder in this repo contains a version of the coding guidelines. Download the latest version of the guidelines that corresponds to your version of MATLAB as indicated in the following table.
But there are no folders with coding guidelines to be found in this repo. Instead I did find a tag for v1.0.0 and an associated Release.
Then I read:
The contents of each folder is as follows.
- codeAnalyzerConfiguration.json
- MATLAB Coding Guidelines.md
- MATLAB Coding Guidelines.pdf
- RevisionHistory.txt
The Release only has a .pdf as asset and of course you can download a zip with the source files for the tag that is consistent with the release. That does contain the codeAnalyzerConfiguration.json and MATLAB Coding Guidelines.md, but not a RevisionHistory.txt and it does include other files that are part of this repo: for instance the README.md, SECURITY.md, License.txt, etc...
I think the README.md should be slightly updated to refer to Releases and I wonder if it is more convenient to have a single .zip as asset with the files that are intended to be downloaded for a release, like the 4 files mentioned above. I personally would prefer not to have folders in a source repo for the versions of the coding guidelines, but indeed to use tags and releases for that.
One more small item: The MATLAB Coding Guidelines.md refers to the images with a relative path starting with .., this relative path is not how the images can be found relative in this repo, as such when viewing the file directly in GitHub, the images are not shown, e.g.:
https://github.com/mathworks/MATLAB-Coding-Guidelines/blob/main/MATLAB-Coding-Guidelines.md#rules
Maybe the relative paths in the .md can be updated or the repo folder structure can be changed to make it work from github.com