From b798cb8589dea9d2daa1503a85b7e8051a158e88 Mon Sep 17 00:00:00 2001 From: hobostay Date: Sun, 26 Oct 2025 18:59:04 +0800 Subject: [PATCH] docs: refine CodingGuidelines wording and clarity --- CodingGuidelines.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/CodingGuidelines.md b/CodingGuidelines.md index fcdecde056..95ca91d53e 100644 --- a/CodingGuidelines.md +++ b/CodingGuidelines.md @@ -1,19 +1,22 @@ -# Code style convention +# Code Style Conventions -Please orient on this guide before you sent a pull request. +Please read this guide before you submit a pull request. --- -## User-interface +## User Interface -Please write a simple user interface for your programs. Not a blinking cursor! -What does the program do? -What want the program an user informations? +Please provide a simple, clear user interface for your programs — not just a blinking cursor. +- Explain what the program does. +- Describe what inputs the user needs to provide. +- Show example usage or prompts when appropriate. --- -## Code style conventions +## Code Style -See [here](https://users.ece.cmu.edu/~eno/coding/CCodingStandard.html) -Don't push all code in one line! +See the [CMU C Coding Standard](https://users.ece.cmu.edu/~eno/coding/CCodingStandard.html). +- Keep code readable and well formatted. +- Do not put all code on one line; use proper indentation and spacing. +- Prefer meaningful names and consistent conventions.