Skip to content

Commit b798cb8

Browse files
committed
docs: refine CodingGuidelines wording and clarity
1 parent e5dad3f commit b798cb8

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

CodingGuidelines.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
1-
# Code style convention
1+
# Code Style Conventions
22

3-
Please orient on this guide before you sent a pull request.
3+
Please read this guide before you submit a pull request.
44

55
---
66

7-
## User-interface
7+
## User Interface
88

9-
Please write a simple user interface for your programs. Not a blinking cursor!
10-
What does the program do?
11-
What want the program an user informations?
9+
Please provide a simple, clear user interface for your programs — not just a blinking cursor.
10+
- Explain what the program does.
11+
- Describe what inputs the user needs to provide.
12+
- Show example usage or prompts when appropriate.
1213

1314
---
1415

15-
## Code style conventions
16+
## Code Style
1617

17-
See [here](https://users.ece.cmu.edu/~eno/coding/CCodingStandard.html)
18-
Don't push all code in one line!
18+
See the [CMU C Coding Standard](https://users.ece.cmu.edu/~eno/coding/CCodingStandard.html).
19+
- Keep code readable and well formatted.
20+
- Do not put all code on one line; use proper indentation and spacing.
21+
- Prefer meaningful names and consistent conventions.
1922

0 commit comments

Comments
 (0)