Skip to content

Commit 8dd3632

Browse files
committed
Fix code quality text.
1 parent 41526a6 commit 8dd3632

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

community/code-quality.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,11 @@ Thank you for your interest in contributing to Slang! We welcome contributions f
33

44
## Code Style and Consistency
55

6-
Follow Project Standards: Adhere to the code style and conventions currently used in Slang. This includes formatting, naming conventions, and structural patterns.
7-
Consistent Formatting: Use spaces/tabs, line lengths, and other formatting elements as defined by the existing code. Consider using linters or formatters if they are part of the project.
8-
Comments and Documentation: Document all public methods, significant logic blocks, and any complex code in a clear, concise manner. Each comment should add value to the code and explain why something is done, not just what it does.
6+
**Follow Project Standards:** Adhere to the code style and conventions currently used in Slang. This includes formatting, naming conventions, and structural patterns.
7+
8+
**Consistent Formatting:** Use spaces/tabs, line lengths, and other formatting elements as defined by the existing code. All code must be formatted with `clang-format` using the configuration in root directory.
9+
10+
**Comments and Documentation:** Document all public methods, significant logic blocks, and any complex code in a clear, concise manner. Each comment should add value to the code and explain why something is done, not just what it does.
911

1012
## Code Efficiency and Performance
1113

0 commit comments

Comments
 (0)