From b125eff95715a1c80d2e584ade4f24b192d225e8 Mon Sep 17 00:00:00 2001 From: Miller Abel Date: Mon, 2 Oct 2023 08:21:24 -0700 Subject: [PATCH] =?UTF-8?q?Update=20guide.md=20=E2=80=94=20correct=20type-?= =?UTF-8?q?o's=20to=20improve=20readability=20(#418)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/community/standards/guide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/community/standards/guide.md b/docs/community/standards/guide.md index 6a34ebc9..2e79f432 100644 --- a/docs/community/standards/guide.md +++ b/docs/community/standards/guide.md @@ -140,7 +140,7 @@ To avoid confusion and guarantee cross-language interpolation, follow these rule - Use Pascal case or camel case for names more than two characters long depending on context (e.g. class names vs variable names). For example, use `SettlementWindow` (Class) or `settlementWindow` (Variable). - You should capitalize abbreviations that consist of only two characters, such as `ID` instead of `Id` when isolated. For example, use `/transfer/{{ID}}` instead of `/transfer/{{Id}}` when representing `ID` as a URI parameter. - Avoid abbreviations in identifiers or parameter names. If you must use abbreviations, use camel case for abbreviations that consist of more than two characters, even if this contradicts the standard abbreviation of the word. -- Use screaming (capitalized) Snack case for Enumerations. For example, use `RECORD_FUNDS_OUT_PREPARE_RESERVE`. +- Use screaming (capitalized) Snake case for Enumerations. For example, use `RECORD_FUNDS_OUT_PREPARE_RESERVE`. Ref: [Microsoft - Design Guidelines for Class Library Developers](https://docs.microsoft.com/en-us/previous-versions/dotnet/netframework-1.1/141e06ef(v=vs.71)?redirectedfrom=MSDN) @@ -552,7 +552,7 @@ npx husky add .husky/pre-commit "npm run audit:check" ##### Automated CI Validations -This will ensure that a auditing checks occur during reviews and releases, and also ensure that Git Pre-Commit Hook are not circumvented. +This will ensure that auditing checks occur during reviews and releases, and also ensure that Git Pre-Commit Hook are not circumvented. CI Configs (i.e. `.circleci/config.yml`) must contain a `vulnerability-check` vulnerability Check CI Job (i.e. `npm run dep:check`) for all Pull-Request, merges to Main branch, and Tagged Releases.