add missing Support Level section
#217
Conversation
There was a problem hiding this comment.
Hey @jeffpaul it's cool to add this back but isn't the support level section a bit redundant when we have the first paragraph in the same readme saying:
WP_Mock is an API mocking framework, built and maintained by 10up and GoDaddy for the purpose of making it possible to properly unit test within a WordPress project.
Then, right below there's also a badge with "Support Active".
Isn't it already implied clearly that the project is in active development? Usually it's the way around when a product is not in active development that the (former) maintainers put a notice at the very top with a large warning saying it's not actively maintained.
| ## Changelog | ||
|
|
||
| A complete listing of all notable changes to Distributor are documented in [CHANGELOG.md](https://github.com/10up/wp_mock/blob/trunk/CHANGELOG.md). | ||
|
|
There was a problem hiding this comment.
Likewise, this too perhaps is a bit redundant.
I was planning on using the automatic changelogs generated by GitHub for each release moving forward, as in https://github.com/10up/wp_mock/releases/tag/0.5.0 - this avoids the manual chore of having to maintain an identical separate file that is just a collection of the same things - in the end it's not a WordPress plugin where it may be helpful to have a list of changes outside of the repo.
Happy to re-include, but this (re)introduces a small burden because each change needs a follow up PR just to update the file, re-approve and merge which could be avoided IMO
I was planning on dropping the CHANGELOG.md file, I actually forgot to do that after moving docs to GitBook and updating the readme recently.
There was a problem hiding this comment.
Those are areas we spell out as expected in https://10up.github.io/Open-Source-Best-Practices/community/#readme, https://10up.github.io/Open-Source-Best-Practices/releasing/#changelog, and https://10up.github.io/Open-Source-Best-Practices/github-process/#support-levels. So perhaps we remove/reduce those initial references?
There was a problem hiding this comment.
never mind I think since the project is hosted by 10up makes sense for consistency to include these then
for the CHANGELOG.md in the end we won't have many releases and I figure it's ok to maintain
Summary
This PR adds in the missing Support Level section to the README.md file so that the Support Level badge link works correctly (e.g., has something to link TO).
Contributor checklist
Testing
n/a
Reviewer checklist