Skip to content

Create a style guide for writing code for SurEau

Writing code when several developers are involved can generate issues (i.e. bugs) at the time deploying it since each developer might follow a different coding practices such as naming conventions or styles.

To avoid this it might be a good idea to define a style guide that aims to define:

  1. Best coding practices for a team

  2. Consistent naming conventions: Variable names, function names, and class names should follow a consistent naming scheme (e.g.,camelCase, underscore notation, or PascalCase).

    Guidelines for naming conventions should be provided, including rules for abbreviations, acronyms, and mixed-case names.

  3. Code organization and structure: Guidelines for directory and file structure should be provided.

    Rules for organizing code into logical sections, such as separate files for functions, classes, or modules, should be established.0

  4. Commenting and documentation:

    Guidelines for commenting code, including what to comment and how to comment, should be provided.

    Rules for documenting functions, classes, and variables should be established.

  5. Error handling and exceptions: Guidelines for error handling and exception handling should be provided, including best practices for error messages and logging.

Other models have implemented it their projects such as Fates and ED2