Skip to content

Commit 29b711f

Browse files
committed
(gitlab) Rewording of some of the gitlab templates
Merge request templates were suitable only for bug fixes. The changes in this commit includes a few lines for (new) features too. Src-commit: 41c178606e88c788ebbb68431b58710c644f75f9
1 parent 115e181 commit 29b711f

File tree

3 files changed

+28
-19
lines changed

3 files changed

+28
-19
lines changed

.gitlab/issue_templates/Bug.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
## Bug Summary
1+
## Bug description
22

3-
(Summarize the bug encountered concisely)
3+
Describe the bug concisely.
44

55
## Steps to reproduce
66

7-
(How to reproduce the issue)
7+
How to reproduce it.
88

9-
## What is the current bug behavior?
9+
## Current vs expected behavior
1010

11-
(What actually happens)
11+
What actually happens and what should happen instead.
1212

13-
## What is the expected correct behavior?
13+
## Hints for a fix
1414

15-
(What should happen instead)
15+
If known, add here any hints to fix it.
1616

1717
/label ~Bug

.gitlab/issue_templates/Feature.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
## Feature Summary
1+
## Feature description
22

3-
(Summarize the new feature concisely)
3+
Describe the new feature concisely (if possible with examples).
44

5-
## Why do we want it?
5+
## Benefits
66

7-
(How is this feature useful?)
7+
For whom and why.
88

99
/label ~NewFeature
+17-8
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,24 @@
1-
(_Relevant module name_) _Commit message_
2-
3-
**Copy issue description without labels**
1+
(_component_) _One-line description_
42

53
## Summary
64

7-
_Explain your solution, changes w.r.t. previous code and mention any
8-
noteworthy aspect of this MR_
5+
Description and motivation of this MR here. If there exist, you may
6+
reuse text from the issue overview here.
7+
8+
For **bug fixes**, this text this should answer (directly or indirectly):
9+
- What was broken? (use examples)
10+
- Wht is the expected behavior? (use examples)
11+
- How is it fixed? (overview of the fix)
12+
- (if applicable) Are there alternative (better) fixes? (which for
13+
some reason we do not implement here)
14+
15+
For **new features**, this text should answer:
16+
- What this new feature adds?
17+
- What are the benefits (for whom and why)?
918

10-
## Why is it the best solution now?
19+
## Detailed description
1120

12-
_(Only if not explained above) Explain why your solution is
13-
implemented this way._
21+
If it not trivial, describe which files, modules, predicates, etc. has
22+
been added/changed.
1423

1524
Closes #_Issue number_

0 commit comments

Comments
 (0)