Skip to content

Commit 01dd640

Browse files
mhibinomhibino
committed
update templates
1 parent 5380e81 commit 01dd640

File tree

12 files changed

+174
-123
lines changed

12 files changed

+174
-123
lines changed

‎.gitlab/issue_templates/Bug.md

+12-13
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,26 @@
1+
<!-- This is to report bugs in code, errors in documentation, things to fix -->
2+
13
## Bug Description
2-
<!-- What is the "Bug" behavior you are seeing? -->
4+
<!-- What is the "Bug" behavior or mistake you are seeing? -->
35

46

57
## Expected Behavior
6-
<!-- What is the "Correct" behavior you should see instead? -->
8+
<!-- What should you see instead? -->
79

810

9-
## Possible Source
10-
<!-- If you can, provide a link to the line of code that may be causing the problem -->
11+
## Steps to Reproduce the Bug
12+
<!-- How can the bug/problem be encountered? -->
1113

1214

13-
## Steps to Reproduce the Bug
14-
<!-- How can the bug/problem be reproduced? (this is very important) -->
15-
<!-- Provide a link to a live example, or an unambiguous set of steps to reproduce the bug -->
16-
1.
17-
2.
18-
3.
15+
## Possible Source / Solution
16+
<!-- If you can, link to the problem's source (e.g., line of code) and/or suggest a solution -->
1917

2018

21-
## Possible Solution
19+
## Logs, Screenshots
20+
<!-- Please use code blocks (```) to format console output, logs, or code -->
2221

2322

24-
## Links, Screenshots, Logs
2523

2624
--------------------------------------------------------------------------------
27-
/label ~"bug"
25+
<!-- Please don't delete! -->
26+
/label ~"Bug"

‎.gitlab/issue_templates/Discussion.md

+14-13
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
1-
<!-- This is a catch-all for discussions that fall out of existing templates -->
1+
<!-- This is to open discussions on various project-related topics -->
22

3-
## Discussion Topic/Question
4-
<!-- Describe the current behavior/state that makes this topic important to address -->
3+
## Discussion Topic
4+
<!-- What is the topic you are opening for discussion? -->
55

6-
## Motivation and Context
7-
<!-- How has this issue effected you? Provide context (e.g. examples, use
8-
cases) -->
96

10-
## Next Steps
11-
<!-- Suggest a concrete way to explore this issue or a possible implementation -->
7+
## Actionable Goals
8+
<!-- What sort of actionable decisions can result from the discussion? -->
129

13-
## External Resources
14-
<!-- Images, links, code-snippets -->
1510

16-
--------------------------------------------------------------------------------
11+
## Food for Discussion
12+
<!-- Add ideas, questions, info to feed the discussion -->
13+
1714

18-
/label ~"discussion"
15+
## Links, Resources
16+
<!-- Add relevant links, images, references -->
1917

20-
**Disclaimer:** This form is a work in progress. Feedback on its components is welcomed!
18+
19+
--------------------------------------------------------------------------------
20+
<!-- Please don't delete! -->
21+
/label ~"Discussion"

‎.gitlab/issue_templates/Feature.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
1+
<!-- This is to propose a new feature, addition to docs, etc. -->
2+
13
## Feature Description
2-
<!-- Describe the feature and how it changes the current state -->
4+
<!-- Describe the feature or enhancement -->
5+
6+
7+
## Motivation
8+
<!-- What problem does it solve? -->
39

4-
## Motivation and Context
5-
<!-- Provide context (e.g., examples and use cases). Why is this feature valuable -->
610

711
## Possible Implementation
8-
<!-- Suggest a solution -- describe your proposed change + any key implementation details -->
12+
<!-- Suggest a way of implementing it -->
913

10-
## Related Issues/Tasks
11-
<!-- Reference open issues by their issue number -->
1214

13-
* **Depends On:**
14-
<!-- List anything that should be completed BEFORE addressing this one as check boxes -->
15+
## Links and Resources
16+
<!-- Add relevant images, links, code-snippets -->
1517

16-
- [ ]
1718

18-
* **Enables:**
19-
<!-- List anything that could/should be addressed AFTER completing this one -->
20-
19+
## Checklist
20+
<!-- List any items to complete -->
2121

22-
## External Resources and Context
23-
<!-- Images, links, code-snippets -->
22+
- [ ]
2423

25-
--------------------------------------------------------------------------------
26-
/label ~"feature"
2724

25+
--------------------------------------------------------------------------------
26+
<!-- Please don't delete! -->
27+
/label ~"Feature"

‎.gitlab/issue_templates/Other.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<!-- This is for issues that don't fit into any of the other templates. -->
2+
3+
--------------------------------------------------------------------------------
4+
<!-- Directions: Add or change things to best capture your issue. -->
5+
6+
## Description
7+
<!-- "What" the issue is about -->
8+
9+
10+
11+
## Motivation
12+
<!-- "Why": context to understanding its importance -->
13+
14+
15+
16+
## Implementation
17+
<!-- "How": ideas for addressing or implementing it -->
18+
19+
20+
21+
## Links, Resources
22+
<!-- Add any relevant links, images, code-snippets, references -->
23+
24+
25+
26+

‎.gitlab/issue_templates/Question.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<!-- This is to ask a question (e.g., about something confusing, difficult, unclear) -->
2+
3+
## Question
4+
<!-- What is your question? -->
5+
6+
7+
## Context
8+
<!-- How did our project/code/docs inspire this question? -->
9+
10+
11+
## Reference, Links
12+
<!-- Add links or references to the particular item, code, or docs -->
13+
14+
15+
16+
--------------------------------------------------------------------------------
17+
<!-- Please don't delete! -->
18+
/label ~"Question"

‎.gitlab/issue_templates/Refactor.md

+12-11
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,24 @@
1+
<!-- This is to propose a refactor or edit -->
2+
13
## Refactor Description
2-
<!-- Describe the refactor -->
4+
<!-- Describe the refactor. -->
5+
36

47
## Motivation
5-
<!-- Why is this refactor valuable? -->
8+
<!-- How does it improve what's currently there? -->
9+
610

711
## Implementation
8-
<!-- Describe any key implementation details or code snippets -->
12+
<!-- Suggest a possible implementation. Use code blocks (```) to format code. -->
913

10-
## Related Issues/Tasks
11-
<!-- Reference open issues by their issue number -->
1214

13-
* **Depends On:**
14-
<!-- List anything that should be completed BEFOREHAND, in check boxes -->
15+
## Checklist
16+
<!-- List any items to complete -->
1517

1618
- [ ]
1719

18-
* **Enables:**
19-
<!-- List anything that could/should FOLLOW the refactor -->
20-
2120

2221
--------------------------------------------------------------------------------
23-
/label ~"refactor"
22+
<!-- Please don't delete! -->
23+
/label ~"Refactor"
24+

‎.gitlab/merge_request_templates/Bug.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
`Bug` Merge Request (MR)
2+
--------------------------------------------------------------------------------
3+
4+
## What does this MR fix?
5+
<!-- Briefly describe what this MR is about -->
6+
7+
8+
9+
## Related Issues
10+
<!-- Mention the issue(s) this MR closes (with "Resolves #") or is related to (with "Relates to #") -->
11+
12+
13+
14+
## Task Checklist
15+
<!-- List any items to complete with this MR -->
16+
17+
- [ ]
18+
19+
20+
--------------------------------------------------------------------------------
21+
<!-- Please don't delete! -->
22+
/label ~"Bug"

‎.gitlab/merge_request_templates/BugFix.md

-24
This file was deleted.

‎.gitlab/merge_request_templates/Feature.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
`Feature` Merge Request (MR)
2+
--------------------------------------------------------------------------------
3+
4+
## What does this MR add?
5+
<!-- Briefly describe what this MR is about -->
6+
7+
8+
9+
## Related Issues
10+
<!-- Mention the issue(s) this MR closes (with "Resolves #") or is related to (with "Relates to #") -->
11+
12+
13+
14+
## Task Checklist
15+
<!-- List any items to complete with this MR -->
16+
17+
- [ ]
18+
19+
20+
21+
--------------------------------------------------------------------------------
22+
<!-- Please don't delete! -->
23+
/label ~"Feature"

‎.gitlab/merge_request_templates/FeatureAdd.md

-30
This file was deleted.

‎.gitlab/merge_request_templates/Other.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<!-- This is for Merge Requests (MRs) that don't fit the other templates. -->
2+
3+
## What does this MR do?
4+
<!-- Briefly describe what this MR is about -->
5+
6+
7+
8+
## Related Issues
9+
<!-- Mention the issue(s) this MR closes (with "Resolves #") or is related to (with "Relates to #") -->
10+
11+
12+
13+
14+
## Task Checklist
15+
<!-- List any items to complete with this MR -->
16+
17+
- [ ]
18+
19+
20+

‎.gitlab/merge_request_templates/Refactor.md

+11-16
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,23 @@
1-
`Refactor` Merge Request
2-
3-
## Related Issue
4-
<!-- Please reference the open issue that this Merge Request resolves by writing, "resolves #" -->
1+
`Refactor` Merge Request (MR)
2+
--------------------------------------------------------------------------------
53

64
## Description of Refactor
7-
<!-- Describe your changes to the previous code -->
8-
<!-- Include any context needed to supplement what is in the open issue -->
5+
<!-- Briefly describe what this MR is about -->
96

10-
## Code
11-
<!-- Paste any code snippets -->
127

13-
## Related Tasks
14-
<!-- List any tasks that need to be completed along with this -->
158

16-
- [ ]
9+
## Related Issues
10+
<!-- Mention the issue(s) this MR closes (with "Resolves #") or is related to (with "Relates to #") -->
1711

1812

19-
## What's Next?
20-
<!-- Are there any potential issues to watch out for? -->
21-
<!-- Are there any particular issues that should be tackled after this? -->
2213

14+
## Task Checklist
15+
<!-- List any items to complete with this MR -->
2316

24-
--------------------------------------------------------------------------------
17+
- [ ]
2518

26-
/label ~"refactor"
2719

2820

21+
--------------------------------------------------------------------------------
22+
<!-- Please don't delete! -->
23+
/label ~"Refactor"

0 commit comments

Comments
 (0)