Add coding guidelines #609

Activity

1. NeoCoderMatrix86

   added

   documentationImprovements or additions to documentationImprovements or additions to documentation

   on Oct 7, 2026
2. NeoCoderMatrix86 commented on Oct 9, 2026

   

   NeoCoderMatrix86

   on Oct 9, 2026

   OwnerAuthor

   More actions

   Usual editorconfig:

   root = true
   
   [*]
   charset = utf-8
   end_of_line = crlf
   insert_final_newline = true
   indent_style = space
   indent_size = 4
   trim_trailing_whitespace = true
   
   [*.{csproj,props,targets,xml,json,yml,yaml}]
   indent_size = 2
   
   [*.cs]
   indent_size = 4
   tab_width = 4
   
   # Organize usings
   dotnet_separate_import_directive_groups = false
   dotnet_sort_system_directives_first = true
   
   # Qualification and framework type names
   dotnet_style_qualification_for_event = false:warning
   dotnet_style_qualification_for_field = false:warning
   dotnet_style_qualification_for_method = false:warning
   dotnet_style_qualification_for_property = false:warning
   dotnet_style_predefined_type_for_locals_parameters_members = true:warning
   dotnet_style_predefined_type_for_member_access = true:warning
   
   # General .NET style
   dotnet_style_coalesce_expression = true:warning
   dotnet_style_collection_initializer = true:warning
   dotnet_style_explicit_tuple_names = true:warning
   dotnet_style_namespace_match_folder = true:warning
   dotnet_style_null_propagation = true:warning
   dotnet_style_object_initializer = true:warning
   dotnet_style_operator_placement_when_wrapping = beginning_of_line
   dotnet_style_prefer_auto_properties = true:warning
   dotnet_style_prefer_compound_assignment = true:warning
   dotnet_style_prefer_conditional_expression_over_assignment = false:warning
   dotnet_style_prefer_conditional_expression_over_return = false:warning
   dotnet_style_prefer_inferred_anonymous_type_member_names = true:warning
   dotnet_style_prefer_inferred_tuple_names = true:warning
   dotnet_style_prefer_is_null_check_over_reference_equality_method = true:warning
   dotnet_style_prefer_simplified_boolean_expressions = true:warning
   dotnet_style_prefer_simplified_interpolation = true:warning
   dotnet_style_readonly_field = true:warning
   dotnet_style_require_accessibility_modifiers = omit_if_default:warning
   
   # C# language style
   csharp_style_conditional_delegate_call = true:warning
   csharp_style_deconstructed_variable_declaration = true:warning
   csharp_style_expression_bodied_accessors = true:warning
   csharp_style_expression_bodied_constructors = false:warning
   csharp_style_expression_bodied_indexers = true:warning
   csharp_style_expression_bodied_lambdas = when_on_single_line:warning
   csharp_style_expression_bodied_local_functions = false:warning
   csharp_style_expression_bodied_methods = when_on_single_line:warning
   csharp_style_expression_bodied_operators = false:warning
   csharp_style_expression_bodied_properties = true:warning
   csharp_style_implicit_object_creation_when_type_is_apparent = true:warning
   csharp_style_inlined_variable_declaration = true:warning
   csharp_style_namespace_declarations = file_scoped:warning
   csharp_style_pattern_matching_over_as_with_null_check = true:warning
   csharp_style_pattern_matching_over_is_with_cast_check = true:warning
   csharp_style_prefer_extended_property_pattern = true:warning
   csharp_style_prefer_index_operator = true:warning
   csharp_style_prefer_local_over_anonymous_function = true:warning
   csharp_style_prefer_method_group_conversion = true:warning
   csharp_style_prefer_not_pattern = true:warning
   csharp_style_prefer_null_check_over_type_check = true:warning
   csharp_style_prefer_pattern_matching = true:warning
   csharp_style_prefer_primary_constructors = false:warning
   csharp_style_prefer_range_operator = true:warning
   csharp_style_prefer_switch_expression = true:warning
   csharp_style_prefer_tuple_swap = true:warning
   csharp_style_prefer_utf8_string_literals = true:warning
   csharp_style_throw_expression = true:warning
   csharp_style_unused_value_assignment_preference = discard_variable:warning
   csharp_style_unused_value_expression_statement_preference = discard_variable:warning
   
   # var preferences
   csharp_style_var_elsewhere = true:error
   csharp_style_var_for_built_in_types = true:error
   csharp_style_var_when_type_is_apparent = true:error
   
   # Modifiers and braces
   csharp_prefer_braces = true:warning
   csharp_prefer_simple_using_statement = true:warning
   csharp_preferred_modifier_order = public,private,protected,internal,file,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,required,volatile,async:warning
   
   # New lines
   csharp_new_line_before_catch = true
   csharp_new_line_before_else = true
   csharp_new_line_before_finally = true
   csharp_new_line_before_members_in_anonymous_types = true
   csharp_new_line_before_members_in_object_initializers = true
   csharp_new_line_between_query_expression_clauses = true
   csharp_new_line_before_open_brace = all
   
   # Indentation
   csharp_indent_block_contents = true
   csharp_indent_braces = false
   csharp_indent_case_contents = true
   csharp_indent_case_contents_when_block = true
   csharp_indent_labels = one_less_than_current
   csharp_indent_switch_labels = true
   
   # Spacing
   csharp_space_after_cast = false
   csharp_space_after_colon_in_inheritance_clause = true
   csharp_space_after_comma = true
   csharp_space_after_dot = false
   csharp_space_after_keywords_in_control_flow_statements = true
   csharp_space_after_semicolon_in_for_statement = true
   csharp_space_around_binary_operators = before_and_after
   csharp_space_around_declaration_statements = false
   csharp_space_before_colon_in_inheritance_clause = true
   csharp_space_before_comma = false
   csharp_space_before_dot = false
   csharp_space_before_open_square_brackets = false
   csharp_space_before_semicolon_in_for_statement = false
   csharp_space_between_empty_square_brackets = false
   csharp_space_between_method_call_empty_parameter_list_parentheses = false
   csharp_space_between_method_call_name_and_opening_parenthesis = false
   csharp_space_between_method_call_parameter_list_parentheses = false
   csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
   csharp_space_between_method_declaration_name_and_open_parenthesis = false
   csharp_space_between_method_declaration_parameter_list_parentheses = false
   csharp_space_between_parentheses = false
   csharp_space_between_square_brackets = false
   
   # Wrapping
   csharp_preserve_single_line_blocks = true
   csharp_preserve_single_line_statements = true
   
   # Naming
   dotnet_naming_rule.types_and_namespaces_should_be_pascal_case.severity = warning
   dotnet_naming_rule.types_and_namespaces_should_be_pascal_case.symbols = types_and_namespaces
   dotnet_naming_rule.types_and_namespaces_should_be_pascal_case.style = pascal_case
   
   dotnet_naming_rule.members_should_be_pascal_case.severity = warning
   dotnet_naming_rule.members_should_be_pascal_case.symbols = members
   dotnet_naming_rule.members_should_be_pascal_case.style = pascal_case
   
   dotnet_naming_rule.interfaces_should_have_prefix.severity = warning
   dotnet_naming_rule.interfaces_should_have_prefix.symbols = interfaces
   dotnet_naming_rule.interfaces_should_have_prefix.style = interface_prefix
   
   dotnet_naming_rule.parameters_and_locals_should_be_camel_case.severity = warning
   dotnet_naming_rule.parameters_and_locals_should_be_camel_case.symbols = parameters_and_locals
   dotnet_naming_rule.parameters_and_locals_should_be_camel_case.style = camel_case
   
   dotnet_naming_rule.private_fields_should_be_camel_case.severity = warning
   dotnet_naming_rule.private_fields_should_be_camel_case.symbols = private_fields
   dotnet_naming_rule.private_fields_should_be_camel_case.style = underscore_camel_case
   
   dotnet_naming_style.underscore_camel_case.required_prefix = _
   dotnet_naming_style.underscore_camel_case.capitalization = camel_case
   
   dotnet_naming_symbols.types_and_namespaces.applicable_kinds = namespace,class,struct,enum,delegate
   dotnet_naming_symbols.types_and_namespaces.applicable_accessibilities = *
   
   dotnet_naming_symbols.members.applicable_kinds = property,event,method
   dotnet_naming_symbols.members.applicable_accessibilities = *
   
   dotnet_naming_symbols.interfaces.applicable_kinds = interface
   dotnet_naming_symbols.interfaces.applicable_accessibilities = *
   
   dotnet_naming_symbols.parameters_and_locals.applicable_kinds = parameter,local
   dotnet_naming_symbols.parameters_and_locals.applicable_accessibilities = *
   
   dotnet_naming_symbols.private_fields.applicable_kinds = field
   dotnet_naming_symbols.private_fields.applicable_accessibilities = private
   
   dotnet_naming_style.pascal_case.capitalization = pascal_case
   dotnet_naming_style.camel_case.capitalization = camel_case
   dotnet_naming_style.interface_prefix.required_prefix = I
   dotnet_naming_style.interface_prefix.capitalization = pascal_case
   
   # Generated code
   [**/Migrations/*.cs]
   generated_code = true
   
   [*.Designer.cs]
   generated_code = true
   
   [*.g.cs]
   generated_code = true
   
   [*.generated.cs]
   generated_code = true
   
   

   Directory.Build.props:

   <Project>
     <PropertyGroup>
       <TargetFramework>net10.0</TargetFramework>
       <Nullable>enable</Nullable>
       <ImplicitUsings>enable</ImplicitUsings>
       <AnalysisLevel>latest-recommended</AnalysisLevel>
       <EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
       <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
       <WarningLevel>9999</WarningLevel>
     </PropertyGroup>
   </Project>
   
   
3. NeoCoderMatrix86

   added this to the next release milestone on Oct 12, 2026
4. NeoCoderMatrix86

   moved this from Concept done (Ready for Sprint) to Current Sprint in AudioCuesheetEditor Developmenton Oct 16, 2026
5. NeoCoderMatrix86

   self-assigned this

   on Oct 16, 2026
6. NeoCoderMatrix86

   moved this from Current Sprint to In Progress in AudioCuesheetEditor Developmenton Oct 16, 2026
7. NeoCoderMatrix86

   linked a pull request that will close this issueAdd coding guidelines #623on Oct 20, 2026
8. NeoCoderMatrix86

   closed this as completedin #623on Oct 20, 2026
9. github-project-automation

   moved this from In Progress to Done in AudioCuesheetEditor Developmenton Oct 20, 2026