add Coding conventions - .editorconfig

[italopessoa]

Spike Plan

Name:

Context:

Outline the reason and context for the spike.

Example: Team needs to use a database to store data for application developed during this subject and must learn to use the Firebird DBMS tools to be able to script the creation and population of the database.

Knowledge Gap:

Skill Gap:

Technology Gap:

Provide details of the appropriate gaps related to this spike.

Example: The team is not familiar with the Firebird DBMS that has been chosen by the subject conveners. Need to install and make use of the following tools for Firebird:

• FSQL command line tool
• FlameRobin GUI admin tool

Goals/Deliverables:

What are the goals and deliverables of this spike? Example:

• Scripts need to create database that models the application domain
• Scripts to insert initial test data into the database
• Batch file, makefile or MSBuild script that includes database setup and tear down

Planned start date: Example: 13/08/2017

Deadline: Example: 20/08/2017

Planning notes:

Outline a proposed plan of how this spike can be undertaken.

Example:

• Design database tables for the team’s application domain.
• Install and configure fsql and flamerobin with embedded Firebird driver if required
• Create scripts to construct the database tables
• Create scripts to populate the database tables with initial test data
• Create scripts to tear down database
• Create batch/makefile/build script with two targets, one to construct and populate (setup) the database, and the other to tear down the database.

[italopessoa]

hey @coderabbitai could you generate a sample .editorconfig file for .net projects?

[italopessoa]

# Editor configuration, see https://editorconfig.org
root = true

[*]
charset = utf-8
indent_style = space
indent_size = 2
insert_final_newline = true
max_line_length = 150
trim_trailing_whitespace = true

[*.md]
max_line_length = off
trim_trailing_whitespace = false

[*.cs]
indent_size = 4

# SA0001: XML comment analysis is disabled due to project configuration
dotnet_diagnostic.SA0001.severity = none

# SA1101: Prefix local calls with this
dotnet_diagnostic.SA1101.severity = none

# S1135: Track uses of "TODO" tags
dotnet_diagnostic.S1135.severity = none

# SA1200: Using directives should be placed correctly
dotnet_diagnostic.SA1200.severity = none

# SA1202: Elements should be ordered by access
dotnet_diagnostic.SA1202.severity = none

# SA1309: Field names should not begin with underscore
dotnet_diagnostic.SA1309.severity = none

# SA1402: File may only contain a single type
dotnet_diagnostic.SA1402.severity = none

# SA1600: Elements should be documented
dotnet_diagnostic.SA1600.severity = none

# SA1615: Element return value should be documented
dotnet_diagnostic.SA1615.severity = none

# SA1623: Property summary documentation should match accessors
dotnet_diagnostic.SA1623.severity = none

# SA1629: Documentation text must end with a period.
dotnet_diagnostic.SA1629.severity = none

# SA1633: File should have header
dotnet_diagnostic.SA1633.severity = none

[*Controller.cs]
# SA1625: Element documentation should not be copied and pasted
dotnet_diagnostic.SA1625.severity = none

[*Test.cs]

# CA1707: Identifiers should not contain underscores
dotnet_diagnostic.CA1707.severity = none

[coderabbitai[bot]]

[!TIP] For best results, initiate chat on the files or code changes.

@italopessoa Here's a sample .editorconfig file tailored for .NET projects. This configuration enforces some common coding standards like indent style, size, and charset which are typically used in .NET/C# environments:

# Top-most EditorConfig file
root = true

# All files
[*]
charset = utf-8
end_of_line = crlf
insert_final_newline = true
trim_trailing_whitespace = true

# C# files
[*.cs]
indent_style = space
indent_size = 4

This file sets up basic rules like UTF-8 charset, CRLF line endings, and trimming of trailing whitespaces for all files. For C# files specifically, it enforces the use of spaces for indentation and sets the indent size to 4 spaces. You can expand this configuration by adding more specific settings according to your team's coding standards or the specific needs of your project.