Miscellaneous issues with existing "standards"

[hugeblank]

This is my first time coming across this project. In my opinion the concept of having standards for CC like this is comedic on its own, but I was at least hoping I'd see some decent organization and a more impressive arrangement of standards since the last time oeed contributed to them. I was disappointed.
Below is the list of inconsistencies I found in the standards:

CCSMB 1

The header defined by the standard is:

*Author: Your Name <@yourgithub>*
*Version: v1.0.0
*Last updated: YYYY-MM-DD*

The header for CCSMB 1 itself does not follow this standard, opting to add an extra newline and a description, not defined by the standard:

*Author: Tomodachi94 <@tomodachi94>*

*Version: v1.0.0*

*Last updated: 2022-11-07*

This RFC defines the protocol for defining and submitting a standard to the CCSMB.

Later in the file:

The RFC should be written in a professional tone. Readers are expected to have a basic understanding of programming jargon and Lua programming.

bit of a nitpick but I feel like the term "programming jargon" coming right after "professional tone" completely side-steps the goal of the section. It could be written better.

CCSMB 2

• Same issue as CCSMB 1, header newlines.
• Version is not prefixed with a v like CCSMB 1 suggests.
• "Last updated" is now "Last revised", and the date has been left blank/with the template string, even though the version seemingly is not the first (1.0.1)

CCSMB 6

• Same issue as CCSMB 1, header newlines.
• Same issue as CCSMB 1, header description.
• Same issue as CCSMB 2, version prefix.
• Same issue as CCSMB 2, "Last updated" -> "Last revised"

CCSMB 7

• Same issue as CCSMB 1, header newlines.
• Same issue as CCSMB 1, header description.
• Same issue as CCSMB 2, version prefix.
• Same issue as CCSMB 2, "Last updated" -> "Last revised"

CCSMB 10

• Same issue as CCSMB 2, template value for "Last updated".
• Version in header is the default template value instead of providing an actual version number.
• Standard has no fallback behavior for "compliant installers" when any of the setting values do not exist.

[tomodachi94]

Thank you for all of this actionable feedback! I'll do my best to address and provide solutions for the issues you raised.

Header formats

The newlines being added was due to the Markdown renderer only making a visible linebreak when two consecutive linebreaks are added. CCSMB-1 should be adjusted to account for this.

Additionally, we should consider adding markdownlint to this repository to enforce consistency.

CCSMB-1

CCSMB-1 is not as thorough as it should be. It has numerous shortcomings, and was mostly written by myself before I had much experience with writing standards.¹

CCSMB-10 and the review process

In my opinion, CCSMB-10 didn't go through a thorough-enough review. We should adjust our policies to ensure that specific expectations are set for a review.

Footnotes

1. There was actually a discussion yesterday about this in the CCSMB Discord. ↩