Skip to content

Commit 6570fde

Browse files
docs(CONTRIBUTING.md): Add clarifications and examples
1 parent c5c8022 commit 6570fde

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

Diff for: CONTRIBUTING.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
## Formatting
55

6-
All entries should be formatted using the `Ctr-D` shortcut for both Lazarus and Delphi entries.
6+
All source code should be formatted using the default formatting rules for Pascal code, which your IDE should provide. Both Lazarus and Delphi uses `Ctr-D` as a shortcut to format your code.
77

88
## Folder name for the entry
99

@@ -13,11 +13,11 @@ For example, using _Gustavo Carreno_ for the name, the folder would be `entries/
1313

1414
## Name of the executable binary
1515

16-
The executable binary follows the same rules has the entry folder above.
16+
The executable binary follows the same rules has the entry folder above; therefore, on Windows, the above example's executable would be `gcarreno.exe` and on Linux, just `gcarreno`.
1717

1818
## Placement of the executable binary
1919

20-
The executable binary should be placed under a folder named `bin` below the root folder of this repository.
20+
The executable binary should be placed under a folder named `bin` below the root folder of this repository (`../../../bin` relative to your source).
2121

2222
This folder is not present on the repository and is being ignored from the `.gitignore`.
2323

@@ -57,7 +57,8 @@ The type is contained within the title and can be one of these types:
5757
Subjects should be no greater than 50 characters, should begin with a capital letter and do not end with a period.
5858

5959
Use an imperative tone to describe what a commit does, rather than what it did. For example, use change; not changed or changes.
60-
The Body
60+
61+
### The Body
6162

6263
Not all commits are complex enough to warrant a body, therefore it is optional and only used when a commit requires a bit of explanation and context. Use the body to explain the what and why of a commit, not the how.
6364

0 commit comments

Comments
 (0)