On 2/20/18 7:50 AM, Ivan Kanakarakis wrote:
* Heather to
create templates for PRs and Issues
The idea is that each pull request should state
a problem and a
solution. I want people to go from "I created this and I want it to be
merged" to "I faced this problem, I solved this way because". (This is
directly related to how commits are separated - a commit should be a
smallest viable change towards solving a bigger issue.) So, the
template I imagine would be something along those lines:
"""
Please, provide an explanation of the problem you faced, or the need you have,
and an explanation of the solution that was implemented.
The pull request description should have at least the following sections:
- Problem: What is problem being solved? What is the needed feature?
- Solution: What is the solution? How is it being solved? (Why is it
solved that way?)
"""
FYI - a first cut at a set of PR and Issue templates are now in the
projects formally accepted under the idpy umbrella.
-Heather