Skip to content

Commit 36431d0

Browse files
authored
Merge pull request #149 from rartych/Github_templates
Github templates for issuses and PRs
2 parents 481e3c0 + 12a3503 commit 36431d0

7 files changed

+148
-0
lines changed

.github/ISSUE_TEMPLATE/config.yml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: 🗣 Subproject discussions
4+
url: https://github.com/camaraproject/EdgeCloud/discussions
5+
about: Please ask and answer questions here.
6+
- name: 📖 CAMARA API Design Guidelines
7+
url: https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md
8+
about: Please refer to the design guidelines.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: ❗ Correction 👣
3+
about: Suggest the correction of an issue in API specification or a misalignment with API design guidelines
4+
title: ''
5+
labels: 'correction'
6+
assignees: ''
7+
8+
---
9+
10+
**Problem description**
11+
<!-- A clear and concise description of what the problem is. -->
12+
13+
**Expected behavior**
14+
<!-- A clear and concise description of what should be changed. -->
15+
16+
17+
**Alternative solution**
18+
<!-- A clear and concise description of any alternative solutions if any. -->
19+
20+
**Additional context**
21+
<!-- Add any other context of the considered correction. -->
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: ❕ Documentation 📝
3+
about: Indicate an issue with API documentation or supplementary documents
4+
title: ''
5+
labels: 'documentation'
6+
assignees: ''
7+
8+
---
9+
10+
**Problem description**
11+
<!-- A clear and concise description of what the problem is. -->
12+
13+
**Expected action**
14+
<!-- A clear and concise description of what should be done. -->
15+
16+
17+
**Additional context**
18+
<!-- Add any other context of the documentation issue e.g. reference documents. -->
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: 💡 Enhancement 🌟
3+
about: Suggest an idea for a new API feature or pose a question on directions for API evolution
4+
title: ''
5+
labels: 'enhancement'
6+
assignees: ''
7+
8+
---
9+
10+
**Problem description**
11+
<!-- A clear and concise description of what the problem is. -->
12+
13+
**Possible evolution**
14+
<!-- A clear and concise description of what can be modified. -->
15+
16+
**Alternative solution**
17+
<!-- A clear and concise description of any alternative solutions or features if any -->
18+
19+
**Additional context**
20+
<!-- Add any other context of the considered enhancement. -->
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: ☁ Subproject management 🎂
3+
about: Indicate an issue with subproject repository or release management
4+
title: ''
5+
labels: 'subproject management'
6+
assignees: ''
7+
8+
---
9+
10+
**Problem description**
11+
<!-- A clear and concise description of what the problem is. -->
12+
13+
**Expected action**
14+
<!-- A clear and concise description of what should be done. -->
15+
16+
17+
**Additional context**
18+
<!-- Add any other context of the management issue e.g. reference documents. -->
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: ⁉ Tests 🔎
3+
about: Indicate an issue with API tests
4+
title: ''
5+
labels: 'tests'
6+
assignees: ''
7+
8+
---
9+
10+
**Problem description**
11+
<!-- A clear and concise description of what the problem is. -->
12+
13+
**Expected action**
14+
<!-- A clear and concise description of what should be done. -->
15+
16+
17+
**Additional context**
18+
<!-- Add any other context of the documentation issue e.g. logs, reference documents. -->

.github/pull_request_template.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
#### What type of PR is this?
2+
3+
Add one of the following kinds:
4+
* bug
5+
* correction
6+
* enhancement/feature
7+
* cleanup
8+
* documentation
9+
* subproject management
10+
* tests
11+
12+
13+
#### What this PR does / why we need it:
14+
15+
16+
17+
18+
#### Which issue(s) this PR fixes:
19+
20+
<!-- Automatically closes linked issue when PR is merged.
21+
Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`. -->
22+
23+
Fixes #
24+
25+
#### Special notes for reviewers:
26+
27+
28+
29+
#### Changelog input
30+
31+
```
32+
release-note
33+
34+
```
35+
36+
#### Additional documentation
37+
38+
This section can be blank.
39+
40+
41+
42+
```
43+
docs
44+
45+
```

0 commit comments

Comments
 (0)