Skip to content

Commit

Permalink
Update GitHub templates (#184)
Browse files Browse the repository at this point in the history
<!--
Filling out the required portions of this template is mandatory. 
Any PR that does not include enough information to be reviewed may be
closed at a maintainers' discretion.
All new code requires associated documentation and unit tests.
-->

# Summary <!-- Required -->

This PR updates the GitHub issue and pull request templates.

## Details <!-- Optional -->

Issue templates are a bit verbose and could use some simplification.

There were references in the bug report to OS, browser, etc. which are
not really applicable to WP_Mock, etc.

Pull requests could use a reviewer checklist which includes references
to the updated CI workflow.

## Contributor checklist <!-- Required -->

<!--- Go over all the following points, and put an `x` in all the boxes
that apply. -->
<!--- If you are unsure about any of these, please ask for
clarification. We are here to help! -->

- [x] I agree to follow this project's [**Code of
Conduct**](https://github.com/10up/.github/blob/trunk/CODE_OF_CONDUCT.md).
- [x] I have updated the documentation accordingly 
    - no documentation changes
- [x] I have added tests to cover changes introduced by this pull
request
    - no code change
- [x] All new and existing tests pass

## Testing <!-- Required -->

<!-- If applicable, add specific steps for the reviewer to perform as
part of their testing process prior to approving this pull request. -->

This PR has no code changes.

<!-- List any configuration requirements for testing. -->

### Reviewer checklist <!-- Required -->

<!-- The following checklist is for the reviewer: add any steps that may
be relevant while reviewing this pull request -->

- [x] Code changes review
- [ ] Documentation changes review
- [x] Unit tests pass
- [x] Static analysis passes
  • Loading branch information
agibson-godaddy authored Dec 22, 2022
2 parents bcfabe0 + 8157238 commit 6a227ea
Show file tree
Hide file tree
Showing 4 changed files with 76 additions and 45 deletions.
53 changes: 24 additions & 29 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <!-- Required -->

<!-- Please write a clear and concise description of what the bug is. -->

### Replication steps <!-- Required -->

<!-- Please describe the steps to reproduce the behavior you've seen. -->

### Expected behavior <!-- Required -->

<!-- Please write a clear and concise description of what you expected to happen. -->

### Logs <!-- Optional -->

<details>
<summary>Log</summary>
```
If applicable, please replace this line with any logs related to the problem you are reporting.
```
</details>

### Screenshots <!-- Optional -->

<!-- If applicable, please add here any screenshots to help explain the problem. -->
12 changes: 4 additions & 8 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <!-- Required -->

**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 <!-- Required -->

**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. -->
40 changes: 40 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
<!--
Filling out the required portions of this template is mandatory.
Any PR that does not include enough information to be reviewed may be closed at a maintainers' discretion.
All new code requires associated documentation and unit tests.
-->

# Summary <!-- Required -->

<!-- Please write a brief high level summary: this should be a summary of the changes which the pull request contains. -->

### Closes: # <!-- Optional: associated GitHub issue -->

## Details <!-- Optional -->

<!-- Please include a detailed explanation of the changes and/or the reasoning behind them. -->

## Contributor checklist <!-- Required -->

<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you are unsure about any of these, please ask for clarification. We are here to help! -->

- [ ] 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 <!-- Required -->

<!-- If applicable, add specific steps for the reviewer to perform as part of their testing process prior to approving this pull request. -->

<!-- List any configuration requirements for testing. -->

### Reviewer checklist <!-- Required -->

<!-- The following checklist is for the reviewer: add any steps that may be relevant while reviewing this pull request -->

- [ ] Code changes review
- [ ] Documentation changes review
- [ ] Unit tests pass
- [ ] Static analysis passes
16 changes: 8 additions & 8 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down

0 comments on commit 6a227ea

Please sign in to comment.