From bc9e509894715e92243bc8272c3a10806804e455 Mon Sep 17 00:00:00 2001 From: Michael Date: Sun, 22 Dec 2024 21:44:22 +0100 Subject: [PATCH] docs: add issue template for new plugin --- .github/ISSUE_TEMPLATE/plugin-request.yaml | 49 ++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/plugin-request.yaml diff --git a/.github/ISSUE_TEMPLATE/plugin-request.yaml b/.github/ISSUE_TEMPLATE/plugin-request.yaml new file mode 100644 index 000000000..fc6ec0193 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/plugin-request.yaml @@ -0,0 +1,49 @@ +name: Plugin request +description: Add a request for a new plugin +title: 'Plugin request' +body: + - type: textarea + id: metric + attributes: + label: Metric + description: Elaborate on the specific metric the plugin will measure. + placeholder: e.g. Code coverage of functions, branches and lines. + validations: + required: true + - type: markdown + attributes: + value: Please provide a concise set of requirements, so that we can process your request as soon as possible. + - type: textarea + id: user-story + attributes: + label: User story + description: Here you can phrase your request in a user story format which highlights the added value of the requested plugin. + placeholder: e.g. As a Code PushUp user, I want to , so that . + validations: + required: true + - type: textarea + id: dependencies + attributes: + label: Dependencies + description: List all added dependencies needed for the plugin (dev-dependencies excluded) + placeholder: e.g. - [ts-morph npm package](https://www.npmjs.com/package/ts-morph) + validations: + required: false + - type: textarea + id: acceptance-criteria + attributes: + label: Acceptance criteria + description: Please list a set of criteria to help us determine whether the scope of the plugin was fully addressed. + placeholder: | + For example: + - [ ] All packages have a comprehensive documentation in place. + - [ ] All unit, integration and e2e tests for the plugin. + - [ ] Cross references to relevant models or files are added as links. + validations: + required: true + - type: textarea + id: implementation-details + attributes: + label: Implementation details + description: If there are any implementation details you would want to point out, feel free to do so here. + placeholder: e.g. A link to a 3rd-party library, relevant article, expected flow details, wireframes highlighting the change or other.