Skip to content

Commit 150087e

Browse files
committed
Starts to add contributing code.
1 parent cf8faab commit 150087e

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,8 @@ Whenever possible, classes should be `final` and `readonly`. This practice promo
107107
_Resources_
108108
* [Why I use final](https://www.youtube.com/watch?v=HiD6CwWq5Ds&ab_channel=PHPAnnotated)
109109

110+
---
111+
110112
#### Acronym Casing
111113
Tempest uses a modified version of the [.NET best practices](https://learn.microsoft.com/en-us/previous-versions/dotnet/netframework-4.0/ms229043(v=vs.100)?redirectedfrom=MSDN) for acronym casing. Please see below for our guidelines:
112114

@@ -119,6 +121,8 @@ A class named `UuidGenerator` is an example of a long acronym (Uuid) used as the
119121
__Do not capitalize any of the characters of any acronyms, whatever their length, at the beginning of a camel-cased identifier.__
120122
A class named `Uuid` is an example of a long acronym (Uuid) used as the first word of a camel-cased identifier. A parameter named `dbUsername` is an example of a short acronym (db) used as the first word of a camel-cased identifier.
121123

124+
---
125+
122126
#### Validaton Class Formatting
123127
1. __Use of `final` and `readonly`__: Ensure that validation rules are declared as [final and readonly](#final-and-readonly-as-a-default) whenever possible. This practice promotes immutability and prevents inadvertent changes to the validation logic.
124128
2. __Error Message Formatting__:

0 commit comments

Comments
 (0)