|
1 | 1 | <!--
|
2 |
| -Hello, and thanks for contributing to imgix-php! 🎉🙌 |
| 2 | +Hello, and thanks for contributing 🎉🙌 |
3 | 3 | Please take a second to fill out PRs with the following template!
|
4 | 4 | -->
|
5 | 5 |
|
6 |
| -# Description |
| 6 | +## Description |
7 | 7 |
|
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.--> |
9 | 10 |
|
10 |
| -<!-- |
11 |
| -Please use the checklist that is most closely related to your PR, and delete the other checklists. --> |
| 11 | +<!-- Before this PR... --> |
12 | 12 |
|
13 |
| -## Checklist: Fixing typos/Doc change |
| 13 | +<!-- After this PR... --> |
14 | 14 |
|
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 --> |
16 | 16 |
|
17 |
| -## Checklist: Bug Fix |
| 17 | +## Checklist |
18 | 18 |
|
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 | +--> |
53 | 22 |
|
54 |
| -## Conventional Commit Spec |
| 23 | +<!-- For all Pull Requests --> |
55 | 24 |
|
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). |
57 | 30 |
|
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--> |
70 | 32 |
|
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