From eb9433fc46ed363a68a273bc810d4301db482ff4 Mon Sep 17 00:00:00 2001 From: Thomas Allmer Date: Wed, 23 Sep 2020 17:30:48 +0200 Subject: [PATCH] chore: improve issue/pull request templates --- .github/ISSUE_TEMPLATE/bug_report.md | 31 +++++------------------ .github/ISSUE_TEMPLATE/feature_request.md | 19 ++++++++++++++ .github/pull_request_template.md | 3 +++ .lintstagedrc.js | 2 +- package.json | 2 +- 5 files changed, 31 insertions(+), 26 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 52f2d2a70..3387a1d3c 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -6,35 +6,18 @@ labels: '' assignees: '' --- -## Describe the bug - -A clear and concise description of what the bug is. - -## To Reproduce - -This is the most important part. Without a simple way of reproducing the issue, we can not verify your bug. - -Here are a few ways you can help us to reproduce the issue: - -1. If you provide us with a Merge Request that has a failing test describing your issue, you are awesome :tada: -2. Alternatively, if it's a more complex bug, it would be even better to create a dedicated repository that we can work on. Please share the link here. -3. If none of the above is possible, please provide us with a list of actions to reproduce the issue (Beware that we will prioritize issues we can reproduce) - -Steps to reproduce the behavior: - -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - ## Expected behavior A clear and concise description of what you expected to happen. -## Screenshots +## Actual Behavior -If applicable, add screenshots to help explain your problem. +Describe what happens instead. Best via a live code reproduction. +To create one click the link below and edit away. +Once the error is reproduced fork/safe and link it. + +https://webcomponents.dev/edit/kpZmz1CJN580OaXsk56f?sv=1&pm=1 ## Additional context -Add any other context about the problem here. +Which component and version of it are you using. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..78e79865f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,19 @@ +--- +name: Feature Request +about: You have an idea about an additional feature +title: '[Feature Request] ...' +labels: '' +assignees: '' +--- + +## Idea + +By adding `my-flag` we can solve ... + +## Straw Man Proposal + +The api could look like this + +```js + +``` diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..7a57296e2 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,3 @@ +## What I did + +1. diff --git a/.lintstagedrc.js b/.lintstagedrc.js index bbdc37185..24fcc155d 100644 --- a/.lintstagedrc.js +++ b/.lintstagedrc.js @@ -4,7 +4,7 @@ module.exports = { '*.js': ['eslint --fix', 'prettier --write', 'git add'], '*.md': [ 'prettier --write', - "markdownlint --ignore '{.changeset/*.md,**/CHANGELOG.md}'", + "markdownlint --ignore '{.github/**/*.md,.changeset/*.md,**/CHANGELOG.md}'", 'git add', ], 'yarn.lock': ['node ./scripts/yarn-lock-scan.js'], diff --git a/package.json b/package.json index 516f44c9a..0509673f7 100644 --- a/package.json +++ b/package.json @@ -17,7 +17,7 @@ "lint": "run-p lint:*", "lint:eclint": "git ls-files | xargs eclint check", "lint:eslint": "eslint --ext .js,.html .", - "lint:markdownlint": "git ls-files '*.md' | xargs markdownlint --ignore '{.changeset/*.md,**/CHANGELOG.md}'", + "lint:markdownlint": "git ls-files '*.md' | xargs markdownlint --ignore '{.github/**/*.md,.changeset/*.md,**/CHANGELOG.md}'", "lint:prettier": "prettier \"**/*.js\" --list-different || (echo '↑↑ these files are not prettier formatted ↑↑' && exit 1)", "lint:types": "tsc", "lint:versions": "node ./scripts/lint-versions.js",