Skip to content

docs: refine CodingGuidelines wording and clarity #1515

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: refine CodingGuidelines wording and clarity #1515

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 12 additions & 9 deletions CodingGuidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.