From 149a6910529d10109ee2075753ee3f6258dfc129 Mon Sep 17 00:00:00 2001 From: Michael Date: Sat, 12 Oct 2024 23:59:20 +0200 Subject: [PATCH] ci: add ISSUE_TEMPLATES --- .github/ISSUE_TEMPLATE/bug-report.yaml | 61 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/feature-request.yaml | 32 +++++++++++ nx.json | 3 +- 4 files changed, 95 insertions(+), 2 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yaml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yaml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml new file mode 100644 index 00000000..ac547080 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -0,0 +1,61 @@ +name: Bug Report +description: File a bug report +title: 'Bug report' +labels: ['🐛 bug'] +body: + - type: markdown + attributes: + value: Please provide all relevant information in order for us to be able to identify and fix the issue as soon as possible. + - type: textarea + id: current-behaviour + attributes: + label: What happened? + description: Here you can describe the issue you are facing. + placeholder: e.g. When I use the --help option, no output appears. + validations: + required: true + - type: textarea + id: expected-behaviour + attributes: + label: What would you expect to happen? + description: Please describe what you expected to happen. + placeholder: e.g. I expected to see a help message with all available arguments in stdout. + validations: + required: false + - type: textarea + id: how-to-reproduce + attributes: + label: What steps did you take? + description: Please provide a step-by-step guide on how to reproduce this issue. + validations: + required: true + - type: input + id: package-version + attributes: + label: Code PushUp package version + description: What version of `@push-based/nx-verdaccio` packages are you using? (check with `npm list @push-based/nx-verdaccio`) + - type: dropdown + id: os + attributes: + label: What operation system are you on? + multiple: false + options: + - Linux + - Windows + - MacOS + validations: + required: true + - type: input + id: node-version + attributes: + label: Node version + description: What Node version are you running? (check with `node -v`) + placeholder: e.g. 20.0.0 + validations: + required: false + - type: textarea + id: logs + attributes: + label: Relevant log output + description: Please copy and paste any relevant log output. This will be automatically formatted into code. + render: shell diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..0086358d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: true diff --git a/.github/ISSUE_TEMPLATE/feature-request.yaml b/.github/ISSUE_TEMPLATE/feature-request.yaml new file mode 100644 index 00000000..c51f5716 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yaml @@ -0,0 +1,32 @@ +name: Feature request +description: Add a request for a new feature or a change +title: 'Feature request' +body: + - 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 feature or change. + placeholder: e.g. As a Code PushUp user, I want to , so that . + validations: + required: true + - 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 request was fully addressed. + placeholder: | + For example: + - [ ] All packages have a comprehensive documentation in place. + - [ ] 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. diff --git a/nx.json b/nx.json index 15e6240b..3d3e44aa 100644 --- a/nx.json +++ b/nx.json @@ -31,8 +31,7 @@ "pb-ve-env-setup": { "cache": true }, - "nx-release-publish": { - }, + "nx-release-publish": {}, "lint": { "executor": "@nx/linter:eslint", "outputs": ["{options.outputFile}"],