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:

  1. Naming Conventions: Guidelines for naming variables, functions, classes, etc.
  2. Formatting Rules: Standards for indentation, spacing, line length, and code organization.
  3. Commenting Guidelines: Recommendations for commenting code effectively, including when and how to comment.
  4. Code Structure: Best practices for structuring code files, modules, and packages.
  5. Coding Style: Consistent style rules for language-specific constructs like loops, conditionals, and error handling.
  6. Error Handling: Guidelines for handling exceptions, errors, and edge cases.
  7. Documentation Standards: Instructions for writing inline documentation, including function/method descriptions and parameter explanations.
  8. Version Control Practices: Recommendations for using version control tools like Git, including branching strategies and commit message conventions.
  9. Testing Guidelines: Standards for writing unit tests, including naming conventions and code coverage goals.