Skip to content
Snippets Groups Projects
Verified Commit e1aa3f74 authored by Lukas Kluft's avatar Lukas Kluft
Browse files

Add recommendations to best practices

parent d661effa
No related branches found
No related tags found
No related merge requests found
......@@ -201,21 +201,22 @@ git branch
6. delete the new branch
# Best practices
(2 slides - Lukas/Georgiana)
- Keep commits as small as possible
- Use one branch per one functionality or bugfix
- Cleanup: delete branches after it was merged into `master`
Commits should deal with only one task, one logical unit
## Best practices - Naming convensions
* Commit **frequently**
* Commit each fix or task as a **separate** change
* Only commit **completed blocks** of work
- Use **meaningful** names for branches
- `feature_<short-desc>` for a new feature
- `bugfix_<short-desc>` for a bugfix
- Use **meaningful** commit message made of a title (max 50 chars) and a body containing a detailed explanation
# Best practices
Write **meaningful** commit messages
1. Use the **imperative mood** in the subject line (**what** is done)
1. **Limit** the subject line to 50 characters
1. Use the body to elaborate **why** changes have been
performed
## Best practices - Good Examples
TODO
# Remote repository & dkrz GitLab
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment