From 9cc5e91b762fc67374b371e8fa8ccf1909c2a8c2 Mon Sep 17 00:00:00 2001 From: Pat Brisbin Date: Wed, 25 Jun 2025 13:03:21 -0400 Subject: [PATCH] Update README.md 1. Mention MS API Guidelines (Closes #61) 2. Mention preference for auto-formatters 3. Fix "Front Row" reference --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 17c2358..c1f8549 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,21 @@ # Freckle Guides -Front Row guides and best practices +Freckle guides and best practices +## Overall Rules + +1. [Microsoft's API Guidelines][ms-api-guides] should be followed + + In case of conflict with content here, we should open an Issue + to propose removing the content here. + + [ms-api-guides]: https://github.com/microsoft/api-guidelines + +2. Defer to a (configured) auto-formatter for all style decisions + + In case of conflict with content here, we should open an Issue + to propose removing the content here. + ## [Fancy Terms](./fancy-terms.md) Why do we use terms like "Monoid" and what do they mean?