Currently, when we create new pull requests, it's a blank slate. Although this may be fine for collaboration between two developers, I think it would be good to establish a format earlier on so that we'll have proper records of our development from as early as possible.
Approach
I only added two sections for the pull request template: Motivation and Approach. These are basically the "why"s and "how"s of your pull requests. The "why" could be as simple as providing an issue number or you could provide additional context. And in the "how", you can include the high level approach you took and go into as much details as you'd like, such as including alternate designs, possible drawbacks, screenshots, and or other resources you used for your pull request.
Motivation
Currently, when we create new pull requests, it's a blank slate. Although this may be fine for collaboration between two developers, I think it would be good to establish a format earlier on so that we'll have proper records of our development from as early as possible.
Approach
I only added two sections for the pull request template:
MotivationandApproach. These are basically the "why"s and "how"s of your pull requests. The "why" could be as simple as providing an issue number or you could provide additional context. And in the "how", you can include the high level approach you took and go into as much details as you'd like, such as including alternate designs, possible drawbacks, screenshots, and or other resources you used for your pull request.