Provide a clear description of the high-level problem you are trying to
solve. The problem statement should be written in terms of a specific
symptom that affects users or the business. The problem statement should
not be written in terms of the solution. If possible, include a minimal
reproducible example (MRE) with steps to reproduce, expected results,
and actual results.
Solution
Provide a clear description of the high-level solution you have chosen.
If there were other possible solutions that you considered and rejected,
mention those along with the corresponding reasoning. Do not describe
implementation details when writing about the solution; these should go
into the implementation section instead.
Testing Done
Provide a clear description of how this change was tested. At minimum
this should include proof that a computer has executed the changed
lines. Ideally this should include an automated test or an explanation
as to why this pull request has no tests.
Provide a clear description of the high-level problem you are trying to solve. The problem statement should be written in terms of a specific symptom that affects users or the business. The problem statement should not be written in terms of the solution. If possible, include a minimal reproducible example (MRE) with steps to reproduce, expected results, and actual results.Problem
Provide a clear description of the high-level solution you have chosen. If there were other possible solutions that you considered and rejected, mention those along with the corresponding reasoning. Do not describe implementation details when writing about the solution; these should go into the implementation section instead.Solution
Provide a clear description of how this change was tested. At minimum this should include proof that a computer has executed the changed lines. Ideally this should include an automated test or an explanation as to why this pull request has no tests.Testing Done