-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: update pr and issue templates
- Loading branch information
Showing
4 changed files
with
116 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
--- | ||
|
||
**Before you submit:** | ||
|
||
- [ ] Please read the [contributing guidelines](CONTRIBUTING.md) | ||
- [ ] Please search through the existing issues (both open AND closed) to see if your issue has been discussed before. Github issue search can be used for this: https://github.com/imgix/vue/issues?utf8=%E2%9C%93&q=is%3Aissue | ||
- [ ] Please ensure the problem has been isolated and reduced. This link explains more: http://css-tricks.com/6263-reduced-test-cases/ | ||
|
||
**Describe the bug** | ||
A clear and concise description of what the bug is. Please strive to reach the **root problem** of your issue to avoid the XY problem. See more: https://meta.stackexchange.com/questions/66377/what-is-the-xy-problem | ||
|
||
**To Reproduce** | ||
A bug is a _demonstrable problem_ that is caused by the code in the repository. Thus, the contributors need a way to reproduce your issue - if we can't reproduce your issue, we can't help you! Also, please be as detailed as possible. | ||
|
||
[a link to a codesandox or repl.it; here is a link to a codesandbox with @imgix/vue installed which can be forked: https://codesandbox.io/s/vue-imgix-base-codesandbox-bhz8n] | ||
|
||
[alternatively, please provide a code example] | ||
|
||
```js | ||
// A *self-contained* demonstration of the problem follows... | ||
// This should be able to be dropped into a file with @imgix/vue installed and just work | ||
``` | ||
|
||
Steps to reproduce the behaviour: | ||
|
||
1. Go to '...' | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See error | ||
|
||
**Expected behaviour** | ||
A clear and concise description of what you expected to happen. | ||
|
||
**Screenshots** | ||
If applicable, add screenshots to help explain your problem. | ||
|
||
**Information:** | ||
|
||
- @imgix/vue version: [e.g. v1.0] | ||
- browser version: [include link from [https://www.whatsmybrowser.org/](https://www.whatsmybrowser.org/) or details about the OS used and browser version] | ||
|
||
**Additional context** | ||
Add any other context about the problem here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
--- | ||
|
||
**Before you submit:** | ||
|
||
- [ ] Please read the [contributing guidelines](CONTRIBUTING.md) | ||
- [ ] Please search through the existing issues (both open AND closed) to see if your feature has already been discussed. Github issue search can be used for this: https://github.com/imgix/vue/issues?utf8=%E2%9C%93&q=is%3Aissue | ||
- [ ] Please take a moment to find out whether your idea fits with the scope and aims of the project | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
**Describe the solution you'd like** | ||
A clear and concise description of how this feature would function. | ||
|
||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
name: Question | ||
about: Ask a question about the project | ||
--- | ||
|
||
**Before you submit:** | ||
|
||
- [ ] Please read the [contributing guidelines](CONTRIBUTING.md) | ||
- [ ] Please search through the existing issues (both open AND closed) to see if your question has already been discussed. Github issue search can be used for this: https://github.com/imgix/vue/issues?utf8=%E2%9C%93&q=is%3Aissue | ||
|
||
**Question** | ||
A clear and concise description of your question |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
<!-- | ||
Hello, and thanks for contributing 🎉🙌 | ||
Please take a second to fill out PRs with the following template! | ||
--> | ||
|
||
## Description | ||
|
||
<!-- What is accomplished by this PR? If there is something potentially | ||
controversial in your PR, please take a moment to tell us about your choices.--> | ||
|
||
<!-- Before this PR... --> | ||
|
||
<!-- After this PR... --> | ||
|
||
<!-- Steps to test: either provide a code snippet that exhibits this change or a link to a codepen/codesandbox demo --> | ||
|
||
## Checklist | ||
|
||
<!-- Please ensure you've completed this checklist before submitting a PR. If | ||
You're not submitting a bugfix or feature, delete that part of the checklist. | ||
--> | ||
|
||
<!-- For all Pull Requests --> | ||
|
||
- [ ] Read the [contributing guidelines](CONTRIBUTING.md). | ||
- [ ] Each commit follows the [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/#summary) spec format. | ||
- [ ] Update the readme (if applicable). | ||
- [ ] Update or add any necessary API documentation (if applicable) | ||
- [ ] All existing unit tests are still passing (if applicable). | ||
|
||
<!-- For new feature and bugfix Pull Requests--> | ||
|
||
- [ ] Add some [steps](#steps-to-test) so we can test your bug fix or feature (if applicable). | ||
- [ ] Add new passing unit tests to cover the code introduced by your PR (if applicable). | ||
- [ ] Any breaking changes are specified on the commit on which they are introduced with `BREAKING CHANGE` in the body of the commit. | ||
- [ ] If this is a big feature with breaking changes, consider [opening an issue][issues] to discuss first. This is completely up to you, but please keep in mind that your PR might not be accepted. |