REM-Freelancer/REM-Mod
4
0
Fork 0
Code Issues 30 Pull Requests Actions Packages Projects Releases Wiki Activity

1.5) GitHub Guidelines 2 aktualisiert

Darklighter
2025-02-26 23:32:37 +00:00
parent 62f525b4fe
commit c1dc1d858b
1 changed files with 10 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
1.5%29-GitHub-Guidelines-2.md

@@ -1,12 +1,14 @@
4. Leave the Description Optional
>
> Use the description field sparingly: The commit description provides space for more detailed information about the change. While this is optional, it should be used to explain the "why" behind the change, not just the "what."
>
> Add context: If the change is complex or addresses a specific issue, include additional details in the description. For example, describe why you made the change or how it improves the codebase.
>
> Example:
> Commit Summary: "Fix authentication issue with OAuth"
> Description: "Resolved issue where the OAuth token was not being stored correctly, leading to authentication failures for users."
```
Use the description field sparingly: The commit description provides space for more detailed information about the change. While this is optional, it should be used to explain the "why" behind the change, not just the "what."
Add context: If the change is complex or addresses a specific issue, include additional details in the description. For example, describe why you made the change or how it improves the codebase.
Example:
Commit Summary: "Fix authentication issue with OAuth"
Description: "Resolved issue where the OAuth token was not being stored correctly, leading to authentication failures for users."
```
5. Use Bullet Points for Multiple Changes