From 9693eaba6de6a6294597d303bbb0ad3a95550db3 Mon Sep 17 00:00:00 2001 From: Mona Mokhber Date: Mon, 5 Jun 2023 12:27:28 +0200 Subject: [PATCH] pr and issues commonalities templates added --- .github/ISSUE_TEMPLATE/config.yml | 5 ++ .github/ISSUE_TEMPLATE/issue_bug_template.md | 33 +++++++++++++ .../issue_correction_template.md | 21 +++++++++ .../issue_documentation_template.md | 18 ++++++++ .../issue_enhancement_template.md | 20 ++++++++ .github/ISSUE_TEMPLATE/issue_pm_template.md | 18 ++++++++ .../ISSUE_TEMPLATE/issue_tests_template.md | 18 ++++++++ .github/pull_request_template.md | 46 +++++++++++++++++++ 8 files changed, 179 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/issue_bug_template.md create mode 100644 .github/ISSUE_TEMPLATE/issue_correction_template.md create mode 100644 .github/ISSUE_TEMPLATE/issue_documentation_template.md create mode 100644 .github/ISSUE_TEMPLATE/issue_enhancement_template.md create mode 100644 .github/ISSUE_TEMPLATE/issue_pm_template.md create mode 100644 .github/ISSUE_TEMPLATE/issue_tests_template.md create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..bc83bc2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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. diff --git a/.github/ISSUE_TEMPLATE/issue_bug_template.md b/.github/ISSUE_TEMPLATE/issue_bug_template.md new file mode 100644 index 0000000..74b4217 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue_bug_template.md @@ -0,0 +1,33 @@ +--- +name: ‼ Bug 🐛 +about: Describe the bug in Provider Implementation +title: '' +labels: 'implementation:bug' +assignees: '' + +--- + +**Describe the bug** + + +**To Reproduce** + + +**Expected behavior** + + +**Screenshots** + + +**Environment:** + + +**Additional context** + diff --git a/.github/ISSUE_TEMPLATE/issue_correction_template.md b/.github/ISSUE_TEMPLATE/issue_correction_template.md new file mode 100644 index 0000000..488e70b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue_correction_template.md @@ -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** + + +**Expected behavior** + + + +**Alternative solution** + + +**Additional context** + diff --git a/.github/ISSUE_TEMPLATE/issue_documentation_template.md b/.github/ISSUE_TEMPLATE/issue_documentation_template.md new file mode 100644 index 0000000..f7b8de0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue_documentation_template.md @@ -0,0 +1,18 @@ +--- +name: ❕ Documentation 📝 +about: Indicate an issue with API documentation or supplementary documents +title: '' +labels: 'documentation' +assignees: '' + +--- + +**Problem description** + + +**Expected action** + + + +**Additional context** + diff --git a/.github/ISSUE_TEMPLATE/issue_enhancement_template.md b/.github/ISSUE_TEMPLATE/issue_enhancement_template.md new file mode 100644 index 0000000..279ce49 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue_enhancement_template.md @@ -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** + + +**Possible evolution** + + +**Alternative solution** + + +**Additional context** + diff --git a/.github/ISSUE_TEMPLATE/issue_pm_template.md b/.github/ISSUE_TEMPLATE/issue_pm_template.md new file mode 100644 index 0000000..210a2f0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue_pm_template.md @@ -0,0 +1,18 @@ +--- +name: ☁ Subproject management 🎂 +about: Indicate an issue with subproject repository or release management +title: '' +labels: 'subproject management' +assignees: '' + +--- + +**Problem description** + + +**Expected action** + + + +**Additional context** + diff --git a/.github/ISSUE_TEMPLATE/issue_tests_template.md b/.github/ISSUE_TEMPLATE/issue_tests_template.md new file mode 100644 index 0000000..170874a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue_tests_template.md @@ -0,0 +1,18 @@ +--- +name: ⁉ Tests 🔎 +about: Indicate an issue with API tests +title: '' +labels: 'tests' +assignees: '' + +--- + +**Problem description** + + +**Expected action** + + + +**Additional context** + diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..cdebc5a --- /dev/null +++ b/.github/pull_request_template.md @@ -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: + + + +Fixes # + +#### Special notes for reviewers: + + + +#### Changelog input + +``` + release-note + +``` + +#### Additional documentation + +This section can be blank. + + + +``` +docs + +```