@@ -198,13 +198,13 @@ to open the pull request for details or open additional issue in GitHub)
198
198
Ensure that there is sufficient detail in issue summaries to make the content of
199
199
the PR clear:
200
200
201
- - a ` TLDR ` of the change content. This is a judgement call on details,
201
+ - a ` TLDR ` of the change content. This is a judgment call on details,
202
202
generally you should include a what was changed and why. The change is
203
203
trivial/short, this can be very short (i.e. "fixed typos" is perfectly
204
204
acceptable, however if changing 100-1000s of line, the areas of changes
205
205
should be explained)
206
206
- If a crash/error is fixed, explain the root cause and if the fix is not
207
- obvious (again, judgement call), explain why the given approach was taken.
207
+ obvious (again, judgment call), explain why the given approach was taken.
208
208
- Help the reviewer out with any notable information (specific platform
209
209
issues, extra thoughts or requests for feedback or gotchas on tricky code,
210
210
followup work or PR dependencies)
@@ -230,7 +230,7 @@ out of convenience.
230
230
updated to cover functionality" or "existing tests already cover this" (make
231
231
sure they do. Integration tests often only cover happy paths).
232
232
233
- Add any notes on not covered things. It is a judgement call on how much can
233
+ Add any notes on not covered things. It is a judgment call on how much can
234
234
be covered as 100% sounds great however not always possible.
235
235
236
236
- Manual testing
0 commit comments