issues
search
Shiv2205
/
SOEN_390_Team_20
https://soen-390-team-20.vercel.app/
2
stars
0
forks
source link
Code convention documentation
#14
Closed
Shiv2205
closed
6 months ago
Shiv2205
commented
6 months ago
Tentative coverage of the code convention document:
Naming Conventions
: Guidelines for naming variables, functions, classes, etc.
Formatting Rules
: Standards for indentation, spacing, line length, and code organization.
Commenting Guidelines
: Recommendations for commenting code effectively, including when and how to comment.
Code Structure
: Best practices for structuring code files, modules, and packages.
Coding Style
: Consistent style rules for language-specific constructs like loops, conditionals, and error handling.
Error Handling
: Guidelines for handling exceptions, errors, and edge cases.
Documentation Standards
: Instructions for writing inline documentation, including function/method descriptions and parameter explanations.
Version Control Practices
: Recommendations for using version control tools like Git, including branching strategies and commit message conventions.
Testing Guidelines
: Standards for writing unit tests, including naming conventions and code coverage goals.
Tentative coverage of the code convention document: