1.5) GitHub Guidelines hinzugefügt
35
1.5%29-GitHub-Guidelines.md
Normal file
35
1.5%29-GitHub-Guidelines.md
Normal file
@@ -0,0 +1,35 @@
|
||||
## 1.5) GitHub Guidelines
|
||||
|
||||
**Disclaimer:** We do not demand that you behave strictly according to this guideline. This is more a help for newcomers to understand the GitHub workflow better.
|
||||
|
||||
When committing changes in GitHub Desktop, it's essential to write clear and effective commit messages. These messages serve as a record of what changes have been made and why. Writing consistent and useful summaries helps both you and your collaborators understand the context of the changes, making it easier to track the history of a project.
|
||||
|
||||
Here are the key rules and best practices for writing commit summaries in GitHub Desktop:
|
||||
|
||||
1. Write a Short, Clear Summary
|
||||
|
||||
```Keep it concise: The summary (or commit message title) should be brief—ideally under 50 characters.
|
||||
|
||||
Describe the change: Clearly state what was changed. Avoid vague messages like "Fixed stuff" or "Changes made."
|
||||
|
||||
Example:
|
||||
Good: "Fix bug in login form validation"
|
||||
Bad: "Fixed stuff"```
|
||||
|
||||
2. Use the Imperative Mood
|
||||
|
||||
```Write in the imperative tone: Use verbs in the present tense, as if you're giving a command. This is the standard for commit messages in Git.
|
||||
|
||||
Example:
|
||||
Good: "Update README with new setup instructions"
|
||||
Bad: "Updated README with new setup instructions"
|
||||
|
||||
The imperative mood aligns with the idea that a commit is an action to be applied to the codebase.```
|
||||
|
||||
3. Capitalize the First Letter
|
||||
|
||||
```Capitalize the first letter of your commit message summary to make it consistent and professional.
|
||||
|
||||
Example:
|
||||
Good: "Add new feature to handle user input"
|
||||
Bad: "add new feature to handle user input"```
|
||||
Reference in New Issue
Block a user