VSadov/Satori
1
0
Fork 0
mirror of https://github.com/VSadov/Satori.git synced 2025-06-08 03:27:04 +09:00
Code Activity

Move clang-format download into dotnet/runtime and add docs for setting up auto-formatting in the repository (#59374)

Browse source
This commit is contained in:
Jeremy Koritzinsky 2021-09-23 14:34:00 -07:00 • committed by GitHub
parent b0872284c9
commit a526e77b6d
Signed by: github
GPG key ID: 4AEE18F83AFDEB23
10 changed files with 238 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/coding-guidelines/coding-style.md
View file

@ -1,7 +1,7 @@
C# Coding Style
===============
For C++ files (*.cpp and *.h), we use clang-format (version 3.6+) to ensure code styling. After changing any Cpp or H file and before merging, src/Native/format-code.sh must be run. This script will ensure that all native code files adhere to the coding style guidelines.
For C++ files (*.cpp and *.h), we use clang-format (version 3.8) to ensure code styling. After changing any Cpp or H file and before merging, src/Native/format-code.sh must be run. This script will ensure that all native code files adhere to the coding style guidelines.
For other types of files (xml, bat, sh, etc), our current best guidance is consistency. When editing files, keep new code and changes consistent with the style in the files. For new files, it should conform to the style for that component. If there is a completely new component, anything that is reasonably broadly accepted is fine. For script files, please refer to the scripting blog for [tips](https://devblogs.microsoft.com/scripting/tag/powertip) and [best practices](https://devblogs.microsoft.com/scripting/tag/best-practices).