Skip to content

Commit 113c325

Browse files
committed
chore: update pr and issue templates
1 parent 9d76ce0 commit 113c325

File tree

4 files changed

+56
-85
lines changed

4 files changed

+56
-85
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+27-9
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,46 @@
11
---
22
name: Bug report
33
about: Create a report to help us improve
4-
title: ''
5-
labels: ''
6-
assignees: ''
7-
84
---
95

10-
Please provide the following information and someone from @imgix/imgix-sdk-team will respond to your issue shortly.
6+
**Before you submit:**
7+
8+
- [ ] Please read the [contributing guidelines](CONTRIBUTING.md)
9+
- [ ] 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
10+
- [ ] Please ensure the problem has been isolated and reduced. This link explains more: http://css-tricks.com/6263-reduced-test-cases/
1111

1212
**Describe the bug**
13-
A clear and concise description of what the bug is.
13+
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
1414

1515
**To Reproduce**
16-
Steps to reproduce the behavior:
16+
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.
17+
18+
[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]
19+
20+
[alternatively, please provide a code example]
1721

18-
**Expected behavior**
22+
```js
23+
// A *self-contained* demonstration of the problem follows...
24+
// This should be able to be dropped into a file with @imgix/vue installed and just work
25+
```
26+
27+
Steps to reproduce the behaviour:
28+
29+
1. Go to '...'
30+
2. Click on '....'
31+
3. Scroll down to '....'
32+
4. See error
33+
34+
**Expected behaviour**
1935
A clear and concise description of what you expected to happen.
2036

2137
**Screenshots**
2238
If applicable, add screenshots to help explain your problem.
2339

2440
**Information:**
25-
- imgix-php version: [e.g. 2.0.0]
41+
42+
- @imgix/vue version: [e.g. v1.0]
43+
- browser version: [include link from [https://www.whatsmybrowser.org/](https://www.whatsmybrowser.org/) or details about the OS used and browser version]
2644

2745
**Additional context**
2846
Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

+4-9
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,19 @@
11
---
22
name: Feature request
33
about: Suggest an idea for this project
4-
title: ''
5-
labels: ''
6-
assignees: ''
7-
84
---
95

10-
Please provide the following information and someone from @imgix/imgix-sdk-team will respond to your issue shortly.
11-
126
**Before you submit:**
137

14-
- [ ] Please search through the [existing issues](https://github.com/imgix/imgix-php/issues?utf8=%E2%9C%93&q=is%3Aissue) to see if your feature has already been discussed.
15-
- [ ] Please take a moment to find out whether your idea fits with the scope and aims of this project.
8+
- [ ] Please read the [contributing guidelines](CONTRIBUTING.md)
9+
- [ ] 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
10+
- [ ] Please take a moment to find out whether your idea fits with the scope and aims of the project
1611

1712
**Is your feature request related to a problem? Please describe.**
1813
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
1914

2015
**Describe the solution you'd like**
21-
A clear and concise description of what you want to happen.
16+
A clear and concise description of how this feature would function.
2217

2318
**Describe alternatives you've considered**
2419
A clear and concise description of any alternative solutions or features you've considered.

.github/ISSUE_TEMPLATE/question.md

+3-8
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,12 @@
11
---
22
name: Question
33
about: Ask a question about the project
4-
title: ''
5-
labels: ''
6-
assignees:
7-
84
---
95

10-
Please provide the following information and someone from @imgix/imgix-sdk-team will respond to your issue shortly.
11-
126
**Before you submit:**
137

14-
- [ ] Please search through the [existing issues](https://github.com/imgix/imgix-php/issues?utf8=%E2%9C%93&q=is%3Aissue) to see if your question has already been discussed.
8+
- [ ] Please read the [contributing guidelines](CONTRIBUTING.md)
9+
- [ ] 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
1510

1611
**Question**
17-
A clear and concise description of your question.
12+
A clear and concise description of your question

.github/pull_request_template.md

+22-59
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,36 @@
11
<!--
2-
Hello, and thanks for contributing to imgix-php! 🎉🙌
2+
Hello, and thanks for contributing 🎉🙌
33
Please take a second to fill out PRs with the following template!
44
-->
55

6-
# Description
6+
## Description
77

8-
<!-- 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. -->
8+
<!-- What is accomplished by this PR? If there is something potentially
9+
controversial in your PR, please take a moment to tell us about your choices.-->
910

10-
<!--
11-
Please use the checklist that is most closely related to your PR, and delete the other checklists. -->
11+
<!-- Before this PR... -->
1212

13-
## Checklist: Fixing typos/Doc change
13+
<!-- After this PR... -->
1414

15-
- [ ] Each commit follows the [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/#summary) format: e.g. `chore(readme): fixed typo`. See the end of this file for more information.
15+
<!-- Steps to test: either provide a code snippet that exhibits this change or a link to a codepen/codesandbox demo -->
1616

17-
## Checklist: Bug Fix
17+
## Checklist
1818

19-
- [ ] Each commit follows the [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/#summary) format: e.g. `chore(readme): fixed typo`. See the end of this file for more information.
20-
- [ ] All existing unit tests are still passing (if applicable)
21-
- [ ] Add new passing unit tests to cover the code introduced by your PR
22-
- [ ] Update the readme
23-
- [ ] Update or add any necessary API documentation
24-
- [ ] Add some [steps](#steps-to-test) so we can test your bug fix
25-
26-
## Checklist: New Feature
27-
28-
- [ ] Each commit follows the [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/#summary) format: e.g. `chore(readme): fixed typo`. See the end of this file for more information.
29-
- [ ] Any breaking changes are specified on the commit on which they are introduced with `BREAKING CHANGE` in the body of the commit.
30-
- [ ] If this is a big feature with breaking changes, consider [opening an issue](https://github.com/imgix/imgix-php/issues/new?assignees=&labels=&template=feature_request.md&title=) to discuss first. This is completely up to you, but please keep in mind that your PR might not be accepted.
31-
- [ ] Run unit tests to ensure all existing tests are still passing
32-
- [ ] Add new passing unit tests to cover the code introduced by your PR
33-
- [ ] Update the readme
34-
- [ ] Add some [steps](#steps-to-test) so we can test your cool new feature!
35-
36-
## Steps to Test
37-
38-
<!-- Delete this selction if you are just submitting a doc change/small fix -->
39-
40-
<!-- A code example or a set of steps is preferred -->
41-
42-
Related issue: [e.g. #42]
43-
44-
Code:
45-
46-
```php
47-
// A standalone example of what the PR solves
48-
```
49-
50-
<!-- A link to a codepen/codesandbox is also an option. -->
51-
52-
<!--
19+
<!-- Please ensure you've completed this checklist before submitting a PR. If
20+
You're not submitting a bugfix or feature, delete that part of the checklist.
21+
-->
5322

54-
## Conventional Commit Spec
23+
<!-- For all Pull Requests -->
5524

56-
PR titles should be in the format `<type>(<scope>): <description>`. For example: `chore(readme): fix typo`
25+
- [ ] Read the [contributing guidelines](CONTRIBUTING.md).
26+
- [ ] Each commit follows the [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/#summary) spec format.
27+
- [ ] Update the readme (if applicable).
28+
- [ ] Update or add any necessary API documentation (if applicable)
29+
- [ ] All existing unit tests are still passing (if applicable).
5730

58-
`type` can be any of the follow:
59-
- `feat`: a feature, or breaking change
60-
- `fix`: a bug-fix
61-
- `test`: Adding missing tests or correcting existing tests
62-
- `docs`: documentation only changes (readme, changelog, contributing guide)
63-
- `refactor`: a code change that neither fixes a bug nor adds a feature
64-
- `chore`: reoccurring tasks for project maintainability (example scopes: release, deps)
65-
- `config`: changes to tooling configurations used in the project
66-
- `build`: changes that affect the build system or external dependencies (example scopes: npm, bundler, gradle)
67-
- `ci`: changes to CI configuration files and scripts (example scopes: travis)
68-
- `perf`: a code change that improves performance
69-
- `style`: changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
31+
<!-- For new feature and bugfix Pull Requests-->
7032

71-
`scope` is optional, and can be anything.
72-
`description` should be a short description of the change, written in the imperative-mood.
73-
-->
33+
- [ ] Add some [steps](#steps-to-test) so we can test your bug fix or feature (if applicable).
34+
- [ ] Add new passing unit tests to cover the code introduced by your PR (if applicable).
35+
- [ ] Any breaking changes are specified on the commit on which they are introduced with `BREAKING CHANGE` in the body of the commit.
36+
- [ ] 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.

0 commit comments

Comments
 (0)