From 8681d46148ee8e416647d463cc75f8132b0eabbd Mon Sep 17 00:00:00 2001 From: Fulvio Notarstefano Date: Thu, 22 Dec 2022 15:36:13 +0800 Subject: [PATCH 1/4] Update GitHub issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 53 ++++++++++------------- .github/ISSUE_TEMPLATE/feature_request.md | 12 ++--- 2 files changed, 28 insertions(+), 37 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index dd84ea78..061206d0 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,32 +7,27 @@ assignees: '' --- -**Describe the bug** -A clear and concise description of what the bug is. - -**To 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** -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] - -**Additional context** -Add any other context about the problem here. +## Bug report + +Please write a clear and concise description of what the bug is. + +### Replication steps + +Please describe the steps to reproduce the behavior you've seen. + +### Expected behavior + +Please write a clear and concise description of what you expected to happen. + +### Logs + +
+Log +``` +If applicable, please replace this line with any logs related to the problem you are reporting. +``` +
+ +### Screenshots + +If applicable, please add here any screenshots to help explain the problem. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index bbcbbe7d..d02e5713 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -7,14 +7,10 @@ assignees: '' --- -**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 [...] +## Feature request -**Describe the solution you'd like** -A clear and concise description of what you want to happen. +Please write a clear and concise description of what problem you'd like to solve with WP_Mock. -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. +### Proposed solution -**Additional context** -Add any other context or screenshots about the feature request here. +Please write a clear and concise description of what you'd like to happen in WP_Mock to support the feature you are proposing. \ No newline at end of file From a3ee6dbd22c93a5eb7b6b7d906130dbff2ab7037 Mon Sep 17 00:00:00 2001 From: Fulvio Notarstefano Date: Thu, 22 Dec 2022 15:49:03 +0800 Subject: [PATCH 2/4] Add pull request template --- .github/pull_request_template.md | 40 ++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..e87b2cd0 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,40 @@ + + +# Summary + + + +### Closes: # + +## Details + + + +## Contributor checklist + + + + +- [ ] I agree to follow this project's [**Code of Conduct**](https://github.com/10up/.github/blob/trunk/CODE_OF_CONDUCT.md). +- [ ] I have updated the documentation accordingly +- [ ] I have added tests to cover changes introduced by this pull request +- [ ] All new and existing tests pass + +## Testing + + + + + +### Reviewer checklist + + + +- [ ] Code changes review +- [ ] Documentation changes review +- [ ] Unit tests pass +- [ ] Static analysis passes \ No newline at end of file From b71a546d0dfc358699b369337c3c5c59e15a7cb4 Mon Sep 17 00:00:00 2001 From: Fulvio Notarstefano Date: Thu, 22 Dec 2022 15:50:37 +0800 Subject: [PATCH 3/4] Comment out portions of gh templates --- .github/ISSUE_TEMPLATE/bug_report.md | 18 +++++++++--------- .github/ISSUE_TEMPLATE/feature_request.md | 8 ++++---- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 061206d0..37c6e9f3 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,19 +7,19 @@ assignees: '' --- -## Bug report +## Bug report -Please write a clear and concise description of what the bug is. + -### Replication steps +### Replication steps -Please describe the steps to reproduce the behavior you've seen. + -### Expected behavior +### Expected behavior -Please write a clear and concise description of what you expected to happen. + -### Logs +### Logs
Log @@ -28,6 +28,6 @@ If applicable, please replace this line with any logs related to the problem you ```
-### Screenshots +### Screenshots -If applicable, please add here any screenshots to help explain the problem. + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index d02e5713..2add3505 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -7,10 +7,10 @@ assignees: '' --- -## Feature request +## Feature request -Please write a clear and concise description of what problem you'd like to solve with WP_Mock. + -### Proposed solution +### Proposed solution -Please write a clear and concise description of what you'd like to happen in WP_Mock to support the feature you are proposing. \ No newline at end of file + \ No newline at end of file From 8157238aa04da68df1313f5b84e650cd6924dbcd Mon Sep 17 00:00:00 2001 From: Fulvio Notarstefano Date: Thu, 22 Dec 2022 16:06:01 +0800 Subject: [PATCH 4/4] Update changelog links --- CHANGELOG.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3855e7ae..b213adba 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,7 +4,7 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [0.5.0] - 2022-11-01 +## [0.5.0](https://github.com/10up/wp_mock/compare/0.4.2...0.5.0) - 2022-11-01 ### Added - New `AnyInstance` matcher ### Changed @@ -14,39 +14,39 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), - Address call to undefined method `getAnnotations` error from test class - Support for latest PHPUnit versions -## [0.4.2] - 2019-03-15 +## [0.4.2](https://github.com/10up/wp_mock/compare/0.4.2...0.4.1) - 2019-03-15 ### Added - **Minor Filter/Action/Hook Assertion Bugfix** - Please note: As with the previously-tagged release, this is not necessarily a stable release! -## [0.4.1] - 2019-02-26 +## [0.4.1](https://github.com/10up/wp_mock/compare/0.4.1...0.4.0) - 2019-02-26 ### Added - **PHPUnit 8 Compatiblity** - This release brings us up to date with the latest release of PHPUnit. - Please note: As with the previously-tagged release, this is not necessarily a stable release! -## [0.4.0] - 2019-01-16 +## [0.4.0](https://github.com/10up/wp_mock/compare/0.4.0...0.3.0) - 2019-01-16 ### Added - **PHPUnit 7 Compatiblity** - This release brings us up to date both with PHPUnit and with PHP itself. The minimum version of PHP now supported by the project is *7.1*. - *Please note:* As with the previously-tagged release, this is not necessarily a stable release! -## [0.3.0] - 2017-12-03 +## [0.3.0](https://github.com/10up/wp_mock/compare/0.3.0...0.2.0) - 2017-12-03 ### Added - This release brings us up to date both with PHPUnit and with PHP itself. The minimum version of PHP now supported by the project is **7.0**. - **Please note:** As with the previously-tagged release, this is not necessarily a stable release! -## [0.2.0] - 2017-07-18 +## [0.2.0](https://github.com/10up/wp_mock/compare/0.2.0...0.1.1) - 2017-07-18 ### Added - **Unstable Distributable Release** - This release moves to using static, tagged versions hosted on Packagist. Aside from a handful of bugfixes, it's equivalent to the `dev-dev` version many have been using before July 2017. Moving forward, all versions will be static and tagged. - **Please note:** As with the previously-tagged release, this is not a stable release! We strongly encourage you to use the 1.0.x-dev source release until we release a stable 1.0 version. -## [0.1.1] - 2015-03-31 +## [0.1.1](https://github.com/10up/wp_mock/compare/0.1.1...0.1.0) - 2015-03-31 ### Added - Better documentation and phpDocumentor output -## [0.1.0] - 2014-12-30 +## [0.1.0](https://github.com/10up/wp_mock/commit/3529a7bcc79d196b2850d15b92b94153b0b871a4) - 2014-12-30 ### Added - **Unstable Distributable Release** - Currently, we only have source releases on Packagist (dev-trunk and 1.0.x-dev). This will be a distributable release that will allow local caching of the library so that not every use needs to be a git clone.