Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Add prompts for metrics, tests, documentation, and hypothesis to validate #1695
Please be sure to read the contributor's guide to the GitHub package before submitting any pull requests.
Description of the Change
Add prompts to ensure that relevant metrics, tests, and documentation are added to pull requests, as well as hypotheses to test once changes are released.
@sguthals, @smashwilson, @annthurium, and I discussed capturing these in a project board or in a tracking issue and decided to give this method a try in order to minimize the number of places we need to look for information.
These prompts will encourage contributors and reviewers to think more holistically about the code changes being introduced and help us keep track of what we need to validate after releasing.
The metrics prompt will help us make data-driven decisions, better understand our users and their behaviors, and draw conclusions about the impact of the changes we've introduced.
The test prompt will hopefully minimize bugs and help code reviewers and future contributors understand the intention of the code introduced.
The documentation prompt will surface useful information to users, maintainers, developers, etc
Documenting all of these in PR descriptions will give maintainers a quick way to see what was introduced in a given release cycle and what needs to be validated by simply looking at the info for each merged Pull Request.
None that I can think of.
added this to In Progress 🔧
in Feature Sprint : 27 August - 14 September 2018 : v0.20.0
Sep 18, 2018
Good question! I checked out the new PR template on