Skip to content

Commit

Permalink
Github templates (#37)
Browse files Browse the repository at this point in the history
* jpengar/github-templates

* remove bug template
  • Loading branch information
jpengar authored May 16, 2023
1 parent b66a5af commit 4d4f84e
Show file tree
Hide file tree
Showing 7 changed files with 146 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: 📖 CAMARA API Design Guidelines
url: https://github.com/camaraproject/WorkingGroups/blob/main/Commonalities/documentation/API-design-guidelines.md
about: Please refer to the design guidelines.
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/issue_correction_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: ❗ Correction 👣
about: Suggest the correction of an issue in API specification or a misalignment with API design guidelines
title: ''
labels: 'correction'
assignees: ''

---

**Problem description**
<!-- A clear and concise description of what the problem is. -->

**Expected behavior**
<!-- A clear and concise description of what should be changed. -->


**Alternative solution**
<!-- A clear and concise description of any alternative solutions if any. -->

**Additional context**
<!-- Add any other context of the considered correction. -->
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/issue_documentation_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: ❕ Documentation 📝
about: Indicate an issue with API documentation or supplementary documents
title: ''
labels: 'documentation'
assignees: ''

---

**Problem description**
<!-- A clear and concise description of what the problem is. -->

**Expected action**
<!-- A clear and concise description of what should be done. -->


**Additional context**
<!-- Add any other context of the documentation issue e.g. reference documents. -->
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/issue_enhancement_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: 💡 Enhancement 🌟
about: Suggest an idea for a new API feature or pose a question on directions for API evolution
title: ''
labels: 'enhancement'
assignees: ''

---

**Problem description**
<!-- A clear and concise description of what the problem is. -->

**Possible evolution**
<!-- A clear and concise description of what can be modified. -->

**Alternative solution**
<!-- A clear and concise description of any alternative solutions or features if any -->

**Additional context**
<!-- Add any other context of the considered enhancement. -->
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/issue_pm_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: ☁ Subproject management 🎂
about: Indicate an issue with subproject repository or release management
title: ''
labels: 'subproject management'
assignees: ''

---

**Problem description**
<!-- A clear and concise description of what the problem is. -->

**Expected action**
<!-- A clear and concise description of what should be done. -->


**Additional context**
<!-- Add any other context of the management issue e.g. reference documents. -->
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/issue_tests_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: ⁉ Tests 🔎
about: Indicate an issue with API tests
title: ''
labels: 'tests'
assignees: ''

---

**Problem description**
<!-- A clear and concise description of what the problem is. -->

**Expected action**
<!-- A clear and concise description of what should be done. -->


**Additional context**
<!-- Add any other context of the documentation issue e.g. logs, reference documents. -->
46 changes: 46 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@

#### What type of PR is this?

Add one of the following kinds:
* bug
* correction
* enhancement/feature
* cleanup
* documentation
* subproject management
* tests


#### What this PR does / why we need it:




#### Which issue(s) this PR fixes:

<!-- Automatically closes linked issue when PR is merged.
Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`. -->

Fixes #

#### Special notes for reviewers:



#### Changelog input

```
release-note
```

#### Additional documentation

This section can be blank.



```
docs
```

0 comments on commit 4d4f84e

Please sign in to comment.