From 46f533b60e5126b412365cd843843f53fe79d471 Mon Sep 17 00:00:00 2001 From: Eugene Fox Date: Fri, 20 Sep 2024 16:50:40 +0300 Subject: [PATCH] Created Code style (markdown) --- Code-style.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 Code-style.md diff --git a/Code-style.md b/Code-style.md new file mode 100644 index 0000000..e2bebe4 --- /dev/null +++ b/Code-style.md @@ -0,0 +1,16 @@ +This article contains a set of rules and guidelines that you should follow when working on an issue. + +This project adopts official [C# Coding Conventions][csharp-cc] and [C# identifier names][csharp-id-names] guidelines provided by Microsoft with few minor additions: +- **Use tabs**, not spaces. +- Use LF file separators (UNIX style). +- Place an empty line in the end of a file. + +There are some key points as well, that are good to keep in mind: +- Prioritize readability over performance. +- More comments is better. + +> [!TIP] +> This repository has additional configuration files that contain some formatting rules and recommended extensions for VS Code editor. So, it is recommended to use VS Code editor during the development, since in this case it will be easier to follow these guidelines. + +[csharp-cc]: https://learn.microsoft.com/dotnet/csharp/fundamentals/coding-style/coding-conventions +[csharp-id-names]: https://learn.microsoft.com/dotnet/csharp/fundamentals/coding-style/identifier-names \ No newline at end of file