Skip to content

Commit 358c637

Browse files
author
Alexandre jublot
committed
chore: added github templates
1 parent 0e2776f commit 358c637

8 files changed

Lines changed: 334 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
name: Bug report
3+
about: Create a bug report to help us improve th project!
4+
title: ''
5+
labels: 'bug'
6+
assignees: 'lolboysg'
7+
8+
---
9+
10+
# [BUG] :
11+
12+
## Description
13+
> Describe your bug shortly.
14+
15+
A bug happened!
16+
17+
## What happened?
18+
> Describe your bug with as much details as possible.
19+
20+
A bug happened!
21+
22+
## Expected behavior
23+
> Describe what should happened with as much details as possible.
24+
25+
This should happened!
26+
27+
## Environment
28+
> Describe your environment with as much details as possible.
29+
30+
- OS and version
31+
- Branch that causes this bug
32+
- ...
33+
34+
## Steps to reproduce
35+
> List the steps to reproduce with as much details as possible.
36+
37+
- You have to do this!
38+
- Then this!
39+
40+
## Relevant log output
41+
> Please copy and paste any relevant log output.
42+
43+
```shell
44+
[bug] This is a usefull log!
45+
```
46+
47+
## Proposed solution
48+
> If you have an idea of how to fix this issue, please write it down here, so we can begin discussing it.
49+
50+
This is a way to solve this bug!

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
name: Bug Report
2+
description: File a bug report
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
assignees:
6+
- 0xtekgrinder # Update it
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for taking the time to fill out this bug report!
12+
- type: textarea
13+
id: description
14+
attributes:
15+
label: Description
16+
description: Describe your bug shortly.
17+
placeholder: Tell us what you see!
18+
value: "A bug happened!"
19+
validations:
20+
required: true
21+
- type: textarea
22+
id: what-happened
23+
attributes:
24+
label: What happened?
25+
description: Describe your bug with as much details as possible.
26+
placeholder: Tell us what you see!
27+
value: "A bug happened!"
28+
validations:
29+
required: true
30+
- type: textarea
31+
id: expected-behaviour
32+
attributes:
33+
label: Expected behaviour
34+
description: Describe what should happened with as much details as possible.
35+
placeholder: Tell us what should happened!
36+
value: "This should happened!"
37+
validations:
38+
required: true
39+
- type: textarea
40+
id: environment
41+
attributes:
42+
label: Environment
43+
description: Describe your environment with as much details as possible.
44+
placeholder: Tell us what is your environment!
45+
value: "- OS and version\n- Branch that causes this bug"
46+
validations:
47+
required: true
48+
- type: textarea
49+
id: steps-to-reproduce
50+
attributes:
51+
label: Steps to reproduce
52+
description: List the steps to reproduce with as much details as possible.
53+
placeholder: Tell us how to reproduce this bug!
54+
value: "- You have to do this!\n- Then this!"
55+
validations:
56+
required: true
57+
- type: textarea
58+
id: logs
59+
attributes:
60+
label: Relevant log output
61+
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
62+
render: C++
63+
validations:
64+
required: false
65+
- type: textarea
66+
id: proposed-solution
67+
attributes:
68+
label: Proposed solution
69+
description: If you have an idea of how to fix this issue, please write it down here, so we can begin discussing it.
70+
validations:
71+
required: false

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Feature request
3+
about: Create a feature request to help us improve the project!
4+
title: ''
5+
labels: 'feature'
6+
assignees: 'lolboysg'
7+
8+
---
9+
10+
# [FEATURE] :
11+
12+
## Description
13+
> Describe your feature shortly.
14+
15+
A new feature!
16+
17+
## Expected behavior
18+
> Describe what you want to happen with as much details as possible.
19+
20+
This should happened!
21+
22+
## Environment
23+
> Describe your environment with as much details as possible.
24+
25+
- OS and version
26+
- ...
27+
28+
## Proposed solution
29+
> If you have an idea of how to realize this feature, please write it down here, so we can begin discussing it.
30+
31+
This is a way to realize this feature!

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: Feature Request
2+
description: File a feature request
3+
title: "[Feature]: "
4+
labels: ["feature", "triage"]
5+
assignees:
6+
- adrienfort # Update it
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for taking the time to fill out this feature request!
12+
- type: textarea
13+
id: description
14+
attributes:
15+
label: Description
16+
description: Describe your feature shortly.
17+
placeholder: Tell us what you want to see!
18+
value: "A new feature!"
19+
validations:
20+
required: true
21+
- type: textarea
22+
id: expected-behaviour
23+
attributes:
24+
label: Expected behaviour
25+
description: Describe what you want to happen with as much details as possible.
26+
placeholder: Tell us what you want to happen!
27+
value: "This should happened!"
28+
validations:
29+
required: true
30+
- type: textarea
31+
id: environment
32+
attributes:
33+
label: Environment
34+
description: Describe your environment with as much details as possible.
35+
placeholder: Tell us what is your environment!
36+
value: "- OS and version"
37+
validations:
38+
required: true
39+
- type: textarea
40+
id: proposed-solution
41+
attributes:
42+
label: Proposed solution
43+
description: If you have an idea of how to realise this feature, please write it down here, so we can begin discussing it.
44+
validations:
45+
required: false

‎.github/milestone_template.md‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
## Overall
2+
3+
### Objective
4+
5+
[Explain here the objective of the milestone]
6+
7+
### Timeline
8+
9+
#### Duration
10+
11+
- [ ] 1 week
12+
- [ ] 2 weeks
13+
- [ ] 3 weeks
14+
15+
#### Date
16+
17+
- Start date : [dd/mm/yyyy]
18+
- End date : [dd/mm/yyyy]
19+
20+
### Checklist
21+
22+
- [ ] Clear objective
23+
- [ ] Consistent objective
24+
- [ ] Achievable in the given time
25+
- [ ] Issues created, with the rights labels and linked to this milestone
26+
- [ ] Issues assigned
27+
28+
## Monitoring
29+
30+
### Week 1
31+
32+
[Detail this week's report]
33+
34+
### Week 2
35+
36+
[Detail this week's report]\
37+
[If this milestone's duration is less than 2 weeks, please delete this section]
38+
39+
### Week 3
40+
41+
[Detail this week's report]\
42+
[If this milestone's duration is less than 3 weeks, please delete this section]
43+
44+
## Final Report
45+
46+
### Checklist
47+
48+
- [ ] Objective fulfilled
49+
- [ ] README.md and other relevant documents (guide, ...) updated
50+
- [ ] Documentation updated
51+
- [ ] Pull requests merged
52+
- [ ] Issues closed
53+
- [ ] Release created
54+
- [ ] Tasks archived
55+
- [ ] Branches cleared
56+
57+
### Questions
58+
59+
**Was this objective fulfilled on time ?**
60+
61+
[Answer this question]
62+
63+
**If not, why ?**
64+
65+
[Answer this question if needed, otherwise delete it]

‎.github/pull_request_template.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Description
2+
3+
Please provide a detailed description of what was done in this PR.
4+
Precise the issue that you are resolving.
5+
6+
# Changes include
7+
8+
- [ ] Bugfix (non-breaking change that solves an issue)
9+
- [ ] New feature (non-breaking change that adds functionality)
10+
- [ ] Breaking change (change that is not backwards-compatible and/or changes current functionality)
11+
12+
# Breaking changes
13+
14+
Please complete this section if any breaking changes have been made, otherwise delete it.
15+
16+
# Checklist
17+
18+
- [ ] I have assigned this PR to myself
19+
- [ ] I have added at least 1 reviewer
20+
- [ ] I have added the needed labels
21+
- [ ] I have linked this PR to an issue
22+
- [ ] I have linked this PR to a milestone
23+
- [ ] I have linked this PR to a project
24+
- [ ] I have tested this code
25+
- [ ] I have added / updated tests (unit / functionals / end-to-end / ...)
26+
- [ ] I have updated the README and other relevant documents (guides...)
27+
- [ ] I have added sufficient documentation both in code, as well as in the READMEs
28+
29+
# Additional comments
30+
31+
Please post additional comments in this section if you have them, otherwise delete it.

‎.github/release-drafter.yml‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name-template: 'v$RESOLVED_VERSION 🌈'
2+
tag-template: 'v$RESOLVED_VERSION'
3+
categories:
4+
- title: '🚀 Features'
5+
collapse-after: 5
6+
labels:
7+
- 'feature'
8+
- 'enhancement'
9+
- title: '🐛 Bug Fixes'
10+
collapse-after: 5
11+
labels:
12+
- 'fix'
13+
- 'bugfix'
14+
- 'bug'
15+
- title: '🧰 Maintenance'
16+
collapse-after: 5
17+
labels:
18+
- 'chore'
19+
- 'dependencies'
20+
- title: '📄 Documentation'
21+
collapse-after: 5
22+
label: 'documentation'
23+
change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
24+
change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks.
25+
version-resolver:
26+
major:
27+
labels:
28+
- 'major'
29+
minor:
30+
labels:
31+
- 'minor'
32+
patch:
33+
labels:
34+
- 'patch'
35+
default: patch
36+
template: |
37+
## Changes
38+
39+
[Describe this new release here]
40+
41+
$CHANGES

‎.github/workflows/.gitkeep‎

Whitespace-only changes.

0 commit comments

Comments
 (0)