Skip to content

Commit c6fb104

Browse files
author
SightBot
committed
chore(gitlab): update issue and merge-request templates
1 parent 0cb6ee9 commit c6fb104

File tree

4 files changed

+124
-0
lines changed

4 files changed

+124
-0
lines changed

.gitlab/issue_templates/Bug.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
### Summary
2+
3+
(Summarize the bug encountered concisely)
4+
5+
### Steps to reproduce
6+
7+
(How one can reproduce the issue - this is very important)
8+
9+
### Dev environment
10+
11+
* OS: (Linux, Windows, MacOS)
12+
* CMake version: (cmake --version)
13+
* Compiler: (gcc/clang/... & version)
14+
* Build type: (debug/release)
15+
* Commit: (current commit or tag)
16+
* (Any related repository commit/tag e.g fw4spl-deps, fw4spl, fw4spl-ar ...)
17+
18+
19+
### What is the current *bug* behavior?
20+
21+
(What actually happens)
22+
23+
### What is the expected *correct* behavior?
24+
25+
(What you should see instead)
26+
27+
### Relevant logs and/or screenshots
28+
29+
(Paste any relevant logs - please use code blocks (```) to format console output,
30+
logs, and code as it's very hard to read otherwise.)
31+
32+
### Possible fixes
33+
34+
(If you can, link to the line of code that might be responsible for the problem)
35+
36+
/label ~"Type:bugfix"

.gitlab/issue_templates/Feature.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
### Description
2+
3+
(Include problem, use cases, benefits, and/or goals)
4+
5+
### Proposal
6+
7+
### Links / references
8+
9+
### Documentation blurb
10+
11+
(Write the start of the documentation of this feature here, include:
12+
13+
1. Why should someone use it; what's the underlying problem.
14+
2. What is the solution.
15+
3. How does someone use this
16+
17+
During implementation, this can then be copied and used as a starter for the documentation.)
18+
19+
/label ~"Type:feature"

.gitlab/issue_templates/Research.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Goal and general information
2+
3+
_Brief description of the goal of this algorithm research task._
4+
5+
# Specification
6+
7+
_Specifications include functional, performance, language and data. The algorithms should focus on solving a specific problem with well-defined interfaces._
8+
9+
# Background
10+
11+
_Background check to see what algorithms exist for solving the problem. Do they meet our needs? Have better new algorithms been published?_
12+
13+
# Data
14+
15+
_Collection of data required for testing (or training in the case of learning-based algorithms). Formatting of data so that it can be inputted to the algorithm._
16+
17+
# Evaluation
18+
19+
_Evaluation framework is used to test the algorithm for correctness and meeting performance specification._
20+
21+
# Baseline
22+
23+
_Existing algorithm selection, implementation and evaluation._
24+
25+
# Prototyping
26+
27+
_The main algorithm research cycle: evaluate performance, make improvements, repeat._
28+
29+
# Integration
30+
31+
_Integration of algorithm code into production system._
32+
33+
# Communication
34+
35+
_Communicate how the algorithm works (internal and/or article publication)._
36+
37+
/label ~"Type:research"
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
## What does this MR do?
2+
3+
(Briefly describe what this MR is about)
4+
5+
## How to test it?
6+
7+
(Describe how to test this feature step by step)
8+
9+
## Data
10+
11+
(link to the needed data)
12+
13+
## Some results
14+
15+
(Some interesting results, screenshot, perfs, ...)
16+
17+
## Additional tests to run
18+
19+
(If you need some specific test e.g Windows compilation...)
20+
21+
- [ ] Build on Windows
22+
- [ ] ...
23+
24+
## Associated Issues/Merge Requests
25+
26+
- Issues
27+
- Fixes repo#number
28+
- [ ] depends on repo#number
29+
30+
- Merge requests
31+
- See also repo!number
32+
- [ ] depends on repo!number

0 commit comments

Comments
 (0)