chore: improve issue/pull request templates
This commit is contained in:
parent
ba72b32b00
commit
eb9433fc46
5 changed files with 31 additions and 26 deletions
31
.github/ISSUE_TEMPLATE/bug_report.md
vendored
31
.github/ISSUE_TEMPLATE/bug_report.md
vendored
|
|
@ -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.
|
||||
|
|
|
|||
19
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
19
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
|
|
@ -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
|
||||
<my-el my-flag="option"></my-el>
|
||||
```
|
||||
3
.github/pull_request_template.md
vendored
Normal file
3
.github/pull_request_template.md
vendored
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
## What I did
|
||||
|
||||
1.
|
||||
|
|
@ -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'],
|
||||
|
|
|
|||
|
|
@ -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",
|
||||
|
|
|
|||
Loading…
Reference in a new issue